Constructor Detail

Method Detail

• threadRunCreated

   final Optional<RunStreamEvent.ThreadRunCreated> threadRunCreated()

  Occurs when a new run is created.

• threadRunQueued

   final Optional<RunStreamEvent.ThreadRunQueued> threadRunQueued()

  Occurs when a run moves to a queued status.

• threadRunInProgress

   final Optional<RunStreamEvent.ThreadRunInProgress> threadRunInProgress()

  Occurs when a run moves to an in_progress status.

• threadRunRequiresAction

   final Optional<RunStreamEvent.ThreadRunRequiresAction> threadRunRequiresAction()

  Occurs when a run moves to a requires_action status.

• threadRunCompleted

   final Optional<RunStreamEvent.ThreadRunCompleted> threadRunCompleted()

  Occurs when a run is completed.

• threadRunIncomplete

   final Optional<RunStreamEvent.ThreadRunIncomplete> threadRunIncomplete()

  Occurs when a run ends with status incomplete.

• threadRunFailed

   final Optional<RunStreamEvent.ThreadRunFailed> threadRunFailed()

  Occurs when a run fails.

• threadRunCancelling

   final Optional<RunStreamEvent.ThreadRunCancelling> threadRunCancelling()

  Occurs when a run moves to a cancelling status.

• threadRunCancelled

   final Optional<RunStreamEvent.ThreadRunCancelled> threadRunCancelled()

  Occurs when a run is cancelled.

• threadRunExpired

   final Optional<RunStreamEvent.ThreadRunExpired> threadRunExpired()

  Occurs when a run expires.

• isThreadRunCreated

   final Boolean isThreadRunCreated()

• isThreadRunQueued

   final Boolean isThreadRunQueued()

• isThreadRunInProgress

   final Boolean isThreadRunInProgress()

• isThreadRunRequiresAction

   final Boolean isThreadRunRequiresAction()

• isThreadRunCompleted

   final Boolean isThreadRunCompleted()

• isThreadRunIncomplete

   final Boolean isThreadRunIncomplete()

• isThreadRunFailed

   final Boolean isThreadRunFailed()

• isThreadRunCancelling

   final Boolean isThreadRunCancelling()

• isThreadRunCancelled

   final Boolean isThreadRunCancelled()

• isThreadRunExpired

   final Boolean isThreadRunExpired()

• asThreadRunCreated

   final RunStreamEvent.ThreadRunCreated asThreadRunCreated()

  Occurs when a new run is created.

• asThreadRunQueued

   final RunStreamEvent.ThreadRunQueued asThreadRunQueued()

  Occurs when a run moves to a queued status.

• asThreadRunInProgress

   final RunStreamEvent.ThreadRunInProgress asThreadRunInProgress()

  Occurs when a run moves to an in_progress status.

• asThreadRunRequiresAction

   final RunStreamEvent.ThreadRunRequiresAction asThreadRunRequiresAction()

  Occurs when a run moves to a requires_action status.

• asThreadRunCompleted

   final RunStreamEvent.ThreadRunCompleted asThreadRunCompleted()

  Occurs when a run is completed.

• asThreadRunIncomplete

   final RunStreamEvent.ThreadRunIncomplete asThreadRunIncomplete()

  Occurs when a run ends with status incomplete.

• asThreadRunFailed

   final RunStreamEvent.ThreadRunFailed asThreadRunFailed()

  Occurs when a run fails.

• asThreadRunCancelling

   final RunStreamEvent.ThreadRunCancelling asThreadRunCancelling()

  Occurs when a run moves to a cancelling status.

• asThreadRunCancelled

   final RunStreamEvent.ThreadRunCancelled asThreadRunCancelled()

  Occurs when a run is cancelled.

• asThreadRunExpired

   final RunStreamEvent.ThreadRunExpired asThreadRunExpired()

  Occurs when a run expires.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(RunStreamEvent.Visitor<T> visitor)

  Maps this instance's current variant to a value of type T using the given visitor.

  Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:

  import com.openai.core.JsonValue;
  import java.util.Optional;
  
  Optional<String> result = runStreamEvent.accept(new RunStreamEvent.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitThreadRunCreated(ThreadRunCreated threadRunCreated) {
          return Optional.of(threadRunCreated.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final RunStreamEvent validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofThreadRunCreated

   final static RunStreamEvent ofThreadRunCreated(RunStreamEvent.ThreadRunCreated threadRunCreated)

  Occurs when a new run is created.

• ofThreadRunQueued

   final static RunStreamEvent ofThreadRunQueued(RunStreamEvent.ThreadRunQueued threadRunQueued)

  Occurs when a run moves to a queued status.

• ofThreadRunInProgress

   final static RunStreamEvent ofThreadRunInProgress(RunStreamEvent.ThreadRunInProgress threadRunInProgress)

  Occurs when a run moves to an in_progress status.

• ofThreadRunRequiresAction

   final static RunStreamEvent ofThreadRunRequiresAction(RunStreamEvent.ThreadRunRequiresAction threadRunRequiresAction)

  Occurs when a run moves to a requires_action status.

• ofThreadRunCompleted

   final static RunStreamEvent ofThreadRunCompleted(RunStreamEvent.ThreadRunCompleted threadRunCompleted)

  Occurs when a run is completed.

• ofThreadRunIncomplete

   final static RunStreamEvent ofThreadRunIncomplete(RunStreamEvent.ThreadRunIncomplete threadRunIncomplete)

  Occurs when a run ends with status incomplete.

• ofThreadRunFailed

   final static RunStreamEvent ofThreadRunFailed(RunStreamEvent.ThreadRunFailed threadRunFailed)

  Occurs when a run fails.

• ofThreadRunCancelling

   final static RunStreamEvent ofThreadRunCancelling(RunStreamEvent.ThreadRunCancelling threadRunCancelling)

  Occurs when a run moves to a cancelling status.

• ofThreadRunCancelled

   final static RunStreamEvent ofThreadRunCancelled(RunStreamEvent.ThreadRunCancelled threadRunCancelled)

  Occurs when a run is cancelled.

• ofThreadRunExpired

   final static RunStreamEvent ofThreadRunExpired(RunStreamEvent.ThreadRunExpired threadRunExpired)

  Occurs when a run expires.