All Implemented Interfaces:


public final class RunStep

Represents a step in execution of a run.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`RunStep.Builder`
`public final class`	`RunStep.LastError`	The last error associated with this run step. Will be `null` if there are no errors.
`public final class`	`RunStep.Status`	The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.
`public final class`	`RunStep.StepDetails`	The details of the run step.
`public final class`	`RunStep.Type`	The type of run step, which can be either `message_creation` or `tool_calls`.
`public final class`	`RunStep.Usage`	Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	The identifier of the run step, which can be referenced in API endpoints.
`final String`	`assistantId()`	The ID of the assistant associated with the run step.
`final Optional<Long>`	`cancelledAt()`	The Unix timestamp (in seconds) for when the run step was cancelled.
`final Optional<Long>`	`completedAt()`	The Unix timestamp (in seconds) for when the run step completed.
`final Long`	`createdAt()`	The Unix timestamp (in seconds) for when the run step was created.
`final Optional<Long>`	`expiredAt()`	The Unix timestamp (in seconds) for when the run step expired.
`final Optional<Long>`	`failedAt()`	The Unix timestamp (in seconds) for when the run step failed.
`final Optional<RunStep.LastError>`	`lastError()`	The last error associated with this run step.
`final JsonValue`	`_metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final JsonValue`	`_object_()`	The object type, which is always `thread.run.step`.
`final String`	`runId()`	The ID of the run that this run step is a part of.
`final RunStep.Status`	`status()`	The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.
`final RunStep.StepDetails`	`stepDetails()`	The details of the run step.
`final String`	`threadId()`	The ID of the thread that was run.
`final RunStep.Type`	`type()`	The type of run step, which can be either `message_creation` or `tool_calls`.
`final Optional<RunStep.Usage>`	`usage()`	Usage statistics related to the run step.
`final JsonField<String>`	`_id()`	The identifier of the run step, which can be referenced in API endpoints.
`final JsonField<String>`	`_assistantId()`	The ID of the assistant associated with the run step.
`final JsonField<Long>`	`_cancelledAt()`	The Unix timestamp (in seconds) for when the run step was cancelled.
`final JsonField<Long>`	`_completedAt()`	The Unix timestamp (in seconds) for when the run step completed.
`final JsonField<Long>`	`_createdAt()`	The Unix timestamp (in seconds) for when the run step was created.
`final JsonField<Long>`	`_expiredAt()`	The Unix timestamp (in seconds) for when the run step expired.
`final JsonField<Long>`	`_failedAt()`	The Unix timestamp (in seconds) for when the run step failed.
`final JsonField<RunStep.LastError>`	`_lastError()`	The last error associated with this run step.
`final JsonField<String>`	`_runId()`	The ID of the run that this run step is a part of.
`final JsonField<RunStep.Status>`	`_status()`	The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.
`final JsonField<RunStep.StepDetails>`	`_stepDetails()`	The details of the run step.
`final JsonField<String>`	`_threadId()`	The ID of the thread that was run.
`final JsonField<RunStep.Type>`	`_type()`	The type of run step, which can be either `message_creation` or `tool_calls`.
`final JsonField<RunStep.Usage>`	`_usage()`	Usage statistics related to the run step.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final RunStep`	`validate()`
`final RunStep.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RunStep.Builder`	`builder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    The identifier of the run step, which can be referenced in API endpoints.
  - assistantId
```
 final String assistantId()
```
    The ID of the assistant associated with the run step.
  - cancelledAt
```
 final Optional<Long> cancelledAt()
```
    The Unix timestamp (in seconds) for when the run step was cancelled.
  - completedAt
```
 final Optional<Long> completedAt()
```
    The Unix timestamp (in seconds) for when the run step completed.
  - createdAt
```
 final Long createdAt()
```
    The Unix timestamp (in seconds) for when the run step was created.
  - expiredAt
```
 final Optional<Long> expiredAt()
```
    The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
  - failedAt
```
 final Optional<Long> failedAt()
```
    The Unix timestamp (in seconds) for when the run step failed.
  - lastError
```
 final Optional<RunStep.LastError> lastError()
```
    The last error associated with this run step. Will be null if there are no errors.
  - _metadata
```
 final JsonValue _metadata()
```
    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.
  - _object_
```
 final JsonValue _object_()
```
    The object type, which is always thread.run.step.
  - runId
```
 final String runId()
```
    The ID of the run that this run step is a part of.
  - status
```
 final RunStep.Status status()
```
    The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
  - stepDetails
```
 final RunStep.StepDetails stepDetails()
```
    The details of the run step.
  - threadId
```
 final String threadId()
```
    The ID of the thread that was run.
  - type
```
 final RunStep.Type type()
```
    The type of run step, which can be either message_creation or tool_calls.
  - usage
```
 final Optional<RunStep.Usage> usage()
```
    Usage statistics related to the run step. This value will be null while the run step's status is in_progress.
  - _id
```
 final JsonField<String> _id()
```
    The identifier of the run step, which can be referenced in API endpoints.
  - _assistantId
```
 final JsonField<String> _assistantId()
```
    The ID of the assistant associated with the run step.
  - _cancelledAt
```
 final JsonField<Long> _cancelledAt()
```
    The Unix timestamp (in seconds) for when the run step was cancelled.
  - _completedAt
```
 final JsonField<Long> _completedAt()
```
    The Unix timestamp (in seconds) for when the run step completed.
  - _createdAt
```
 final JsonField<Long> _createdAt()
```
    The Unix timestamp (in seconds) for when the run step was created.
  - _expiredAt
```
 final JsonField<Long> _expiredAt()
```
    The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
  - _failedAt
```
 final JsonField<Long> _failedAt()
```
    The Unix timestamp (in seconds) for when the run step failed.
  - _lastError
```
 final JsonField<RunStep.LastError> _lastError()
```
    The last error associated with this run step. Will be null if there are no errors.
  - _runId
```
 final JsonField<String> _runId()
```
    The ID of the run that this run step is a part of.
  - _status
```
 final JsonField<RunStep.Status> _status()
```
    The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
  - _stepDetails
```
 final JsonField<RunStep.StepDetails> _stepDetails()
```
    The details of the run step.
  - _threadId
```
 final JsonField<String> _threadId()
```
    The ID of the thread that was run.
  - _type
```
 final JsonField<RunStep.Type> _type()
```
    The type of run step, which can be either message_creation or tool_calls.
  - _usage
```
 final JsonField<RunStep.Usage> _usage()
```
    Usage statistics related to the run step. This value will be null while the run step's status is in_progress.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final RunStep validate()
```
  - toBuilder
```
 final RunStep.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RunStep.Builder builder()
```

Class RunStep

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

assistantId

cancelledAt

completedAt

createdAt

expiredAt

failedAt

lastError

_metadata

_object_

runId

status

stepDetails

threadId

type

usage

_id

_assistantId

_cancelledAt

_completedAt

_createdAt

_expiredAt

_failedAt

_lastError

_runId

_status

_stepDetails

_threadId

_type

_usage

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder