Liking cljdoc? Tell your friends :D

temporal.client.options


schedule-client-optionsclj

ScheduleClientOptions configuration map (See temporal.client.schedule/create-client)

ValueDescriptionTypeDefault
:targetSets the connection host:portString"127.0.0.1:7233"
:identityOverrides the worker node identity (workers only)String
:namespaceSets the Temporal namespace context for this clientString
:data-converterOverrides the data converter used to serialize arguments and results.DataConverter
`ScheduleClientOptions` configuration map (See [[temporal.client.schedule/create-client]])

| Value                     | Description                                                                 | Type         | Default |
| ------------------------- | --------------------------------------------------------------------------- | ------------ | ------- |
| :target                   | Sets the connection host:port                                               | String       | "127.0.0.1:7233" |
| :identity                 | Overrides the worker node identity (workers only)                           | String       | |
| :namespace                | Sets the Temporal namespace context for this client                         | String       | |
| :data-converter           | Overrides the data converter used to serialize arguments and results.       | [DataConverter](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/common/converter/DataConverter.html) | |
sourceraw docstring

service-stub->clj

(service-stub-> options timeout)
source

stub-optionsclj

WorkflowServiceStubsOptions configuration map (See temporal.client.core/create-client or temporal.client.schedule/create-client)

ValueDescriptionTypeDefault
:channelSets gRPC channel to use. Exclusive with target and sslContextManagedChannel
:ssl-contextSets gRPC SSL Context to use (See temporal.tls/new-ssl-context)SslContext
:enable-httpsSets option to enable SSL/TLS/HTTPS for gRPCbooleanfalse
:rpc-timeoutSets the rpc timeout value for non query and non long poll callsDuration10s
:rpc-long-poll-timeoutSets the rpc timeout valueDuration60s
:rpc-query-timeoutSets the rpc timeout for queriesDuration10s
:backoff-reset-freqSets frequency at which gRPC connection backoff should be reset practicallyDuration10s
:grpc-reconnect-freqSets frequency at which gRPC channel will be moved into an idle stateDuration60s
:headersSet the headersMetadata
:enable-keepaliveSet keep alive ping from client to the serverbooleanfalse
:keepalive-timeSet the keep alive timeDuration
:keepalive-timeoutSet the keep alive timeoutDuration
:keepalive-without-streamSet if client sends keepalive pings even with no active RPCsbooleanfalse
:metrics-scopeThe scope to be used for metrics reportingScope
`WorkflowServiceStubsOptions` configuration map (See [[temporal.client.core/create-client]] or [[temporal.client.schedule/create-client]])

| Value                     | Description                                                                 | Type         | Default |
| ------------------------- | --------------------------------------------------------------------------- | ------------ | ------- |
| :channel                  | Sets gRPC channel to use. Exclusive with target and sslContext              | [ManagedChannel](https://grpc.github.io/grpc-java/javadoc/io/grpc/ManagedChannel.html) | |
| :ssl-context              | Sets gRPC SSL Context to use (See [[temporal.tls/new-ssl-context]])         | [SslContext](https://netty.io/4.0/api/io/netty/handler/ssl/SslContext.html) | |
| :enable-https             | Sets option to enable SSL/TLS/HTTPS for gRPC                                | boolean      | false |
| :rpc-timeout              | Sets the rpc timeout value for non query and non long poll calls            | [Duration](https://docs.oracle.com/javase/8/docs/api//java/time/Duration.html) | 10s |
| :rpc-long-poll-timeout    | Sets the rpc timeout value                                                  | [Duration](https://docs.oracle.com/javase/8/docs/api//java/time/Duration.html) | 60s |
| :rpc-query-timeout        | Sets the rpc timeout for queries                                            | [Duration](https://docs.oracle.com/javase/8/docs/api//java/time/Duration.html) | 10s |
| :backoff-reset-freq       | Sets frequency at which gRPC connection backoff should be reset practically | [Duration](https://docs.oracle.com/javase/8/docs/api//java/time/Duration.html) | 10s |
| :grpc-reconnect-freq      | Sets frequency at which gRPC channel will be moved into an idle state       | [Duration](https://docs.oracle.com/javase/8/docs/api//java/time/Duration.html) | 60s |
| :headers                  | Set the headers                                                             | [Metadata](https://grpc.github.io/grpc-java/javadoc/io/grpc/Metadata.html) | |
| :enable-keepalive         | Set keep alive ping from client to the server                               | boolean       | false |
| :keepalive-time           | Set the keep alive time                                                     | [Duration](https://docs.oracle.com/javase/8/docs/api//java/time/Duration.html) | |
| :keepalive-timeout        | Set the keep alive timeout                                                  | [Duration](https://docs.oracle.com/javase/8/docs/api//java/time/Duration.html) | |
| :keepalive-without-stream | Set if client sends keepalive pings even with no active RPCs                | boolean       | false |
| :metrics-scope            | The scope to be used for metrics reporting                                  | [Scope](https://github.com/uber-java/tally/blob/master/core/src/main/java/com/uber/m3/tally/Scope.java) | |
sourceraw docstring

stub-options->clj

(stub-options-> params)
source

workflow-client-optionsclj

WorkflowClientOptions configuration map (See temporal.client.core/create-client)

ValueDescriptionTypeDefault
:targetSets the connection host:portString"127.0.0.1:7233"
:identityOverrides the worker node identity (workers only)String
:namespaceSets the Temporal namespace context for this clientString
:data-converterOverrides the data converter used to serialize arguments and results.DataConverter
:interceptorsCollection of interceptors used to intercept workflow client calls.WorkflowClientInterceptor
`WorkflowClientOptions` configuration map (See [[temporal.client.core/create-client]])

| Value                     | Description                                                                 | Type         | Default |
| ------------------------- | --------------------------------------------------------------------------- | ------------ | ------- |
| :target                   | Sets the connection host:port                                               | String       | "127.0.0.1:7233" |
| :identity                 | Overrides the worker node identity (workers only)                           | String       | |
| :namespace                | Sets the Temporal namespace context for this client                         | String       | |
| :data-converter           | Overrides the data converter used to serialize arguments and results.       | [DataConverter](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/common/converter/DataConverter.html) | |
| :interceptors             | Collection of interceptors used to intercept workflow client calls.         | [WorkflowClientInterceptor](https://javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/common/interceptors/WorkflowClientInterceptor.html) | |
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close