Class ChatKitWorkflow
-
- All Implemented Interfaces:
public final class ChatKitWorkflow
Workflow metadata and state returned for the session.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ChatKitWorkflow.Builder
A builder for ChatKitWorkflow.
public final class
ChatKitWorkflow.StateVariables
State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided.
public final class
ChatKitWorkflow.Tracing
Tracing settings applied to the workflow.
-
Method Summary
Modifier and Type Method Description final String
id()
Identifier of the workflow backing the session. final Optional<ChatKitWorkflow.StateVariables>
stateVariables()
State variable key-value pairs applied when invoking the workflow. final ChatKitWorkflow.Tracing
tracing()
Tracing settings applied to the workflow. final Optional<String>
version()
Specific workflow version used for the session. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<ChatKitWorkflow.StateVariables>
_stateVariables()
Returns the raw JSON value of stateVariables. final JsonField<ChatKitWorkflow.Tracing>
_tracing()
Returns the raw JSON value of tracing. final JsonField<String>
_version()
Returns the raw JSON value of version. final Map<String, JsonValue>
_additionalProperties()
final ChatKitWorkflow.Builder
toBuilder()
final ChatKitWorkflow
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ChatKitWorkflow.Builder
builder()
Returns a mutable builder for constructing an instance of ChatKitWorkflow. -
-
Method Detail
-
stateVariables
final Optional<ChatKitWorkflow.StateVariables> stateVariables()
State variable key-value pairs applied when invoking the workflow. Defaults to null when no overrides were provided.
-
tracing
final ChatKitWorkflow.Tracing tracing()
Tracing settings applied to the workflow.
-
version
final Optional<String> version()
Specific workflow version used for the session. Defaults to null when using the latest deployment.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_stateVariables
final JsonField<ChatKitWorkflow.StateVariables> _stateVariables()
Returns the raw JSON value of stateVariables.
Unlike stateVariables, this method doesn't throw if the JSON field has an unexpected type.
-
_tracing
final JsonField<ChatKitWorkflow.Tracing> _tracing()
Returns the raw JSON value of tracing.
Unlike tracing, this method doesn't throw if the JSON field has an unexpected type.
-
_version
final JsonField<String> _version()
Returns the raw JSON value of version.
Unlike version, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatKitWorkflow.Builder toBuilder()
-
validate
final ChatKitWorkflow validate()
-
builder
final static ChatKitWorkflow.Builder builder()
Returns a mutable builder for constructing an instance of ChatKitWorkflow.
The following fields are required:
.id() .stateVariables() .tracing() .version()
-
-
-
-