Struct ThreadResumeParams 

pub struct ThreadResumeParams {

    pub thread_id: String,
    pub history: Option<Vec<ResponseItem>>,
    pub path: Option<PathBuf>,
    pub model: Option<String>,
    pub model_provider: Option<String>,
    pub service_tier: Option<Option<String>>,
    pub cwd: Option<String>,
    pub runtime_workspace_roots: Option<Vec<AbsolutePathBuf>>,
    pub approval_policy: Option<AskForApproval>,
    pub approvals_reviewer: Option<ApprovalsReviewer>,
    pub sandbox: Option<SandboxMode>,
    pub permissions: Option<String>,
    pub config: Option<HashMap<String, Value>>,
    pub base_instructions: Option<String>,
    pub developer_instructions: Option<String>,
    pub personality: Option<Personality>,
    pub exclude_turns: bool,
    pub initial_turns_page: Option<ThreadResumeInitialTurnsPageParams>,
}

There are three ways to resume a thread:

1. By thread_id: load the thread from disk by thread_id and resume it.
2. By history: instantiate the thread from memory and resume it.
3. By path: load the thread from disk by path and resume it.

For non-running threads, the precedence is: history > non-empty path > thread_id. If using history or a non-empty path for a non-running thread, the thread_id param will be ignored.

If thread_id identifies a running thread, app-server rejoins that thread and treats a non-empty path as a consistency check against the active rollout path. Empty string path values are treated as absent.

Prefer using thread_id whenever possible.

Fields

thread_id: String

history: Option<Vec<ResponseItem>>

[UNSTABLE] FOR CODEX CLOUD - DO NOT USE. If specified, the thread will be resumed with the provided history instead of loaded from disk.

path: Option<PathBuf>

[UNSTABLE] Specify the rollout path to resume from. If specified for a non-running thread, the thread_id param will be ignored. If thread_id identifies a running thread, the path must match the active rollout path.

model: Option<String>

Configuration overrides for the resumed thread, if any.

model_provider: Option<String>

service_tier: Option<Option<String>>

cwd: Option<String>

runtime_workspace_roots: Option<Vec<AbsolutePathBuf>>

Replace the thread’s runtime workspace roots. Paths must be absolute.

approval_policy: Option<AskForApproval>

approvals_reviewer: Option<ApprovalsReviewer>

Override where approval requests are routed for review on this thread and subsequent turns.

sandbox: Option<SandboxMode>

permissions: Option<String>

Named profile id for the resumed thread. Cannot be combined with sandbox.

config: Option<HashMap<String, Value>>

base_instructions: Option<String>

developer_instructions: Option<String>

personality: Option<Personality>

exclude_turns: bool

When true, return only thread metadata and live-resume state without populating thread.turns. This is useful when the client plans to call thread/turns/list immediately after resuming.

initial_turns_page: Option<ThreadResumeInitialTurnsPageParams>

When present, include a thread/turns/list page in the resume response so clients can bootstrap recent turns without a second request.

Trait Implementations

impl Clone for ThreadResumeParams

fn clone(&self) -> ThreadResumeParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThreadResumeParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ThreadResumeParams

fn default() -> ThreadResumeParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ThreadResumeParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExperimentalApi for ThreadResumeParams

fn experimental_reason(&self) -> Option<&'static str>

Returns a short reason identifier when an experimental method or field is used, or None when the value is entirely stable.

impl JsonSchema for ThreadResumeParams

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ThreadResumeParams

fn eq(&self, other: &ThreadResumeParams) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ThreadResumeParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ThreadResumeParams

impl TS for ThreadResumeParams

type WithoutGenerics = ThreadResumeParams

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ThreadResumeParams

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.