Constructor Detail

Method Detail

• body

   final RunCreateParams.Builder body(RunCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • agentId

  • prompt

  • callbackUrl

  • guidance

  • model

  • etc.

• agentId

   final RunCreateParams.Builder agentId(String agentId)

  ID of the agent to run

• agentId

   final RunCreateParams.Builder agentId(JsonField<String> agentId)

  Sets Builder.agentId to an arbitrary JSON value.

  You should usually call Builder.agentId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• prompt

   final RunCreateParams.Builder prompt(String prompt)

  Task prompt for the agent

• prompt

   final RunCreateParams.Builder prompt(JsonField<String> prompt)

  Sets Builder.prompt to an arbitrary JSON value.

  You should usually call Builder.prompt with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• callbackUrl

   final RunCreateParams.Builder callbackUrl(String callbackUrl)

  HTTPS callback URL to receive a notification when the run completes. Registered atomically with the run — eliminates the race condition of calling /watch after /exec. Additional watchers can still be added via POST /run/:id/watch.

• callbackUrl

   final RunCreateParams.Builder callbackUrl(Optional<String> callbackUrl)

  Alias for calling Builder.callbackUrl with callbackUrl.orElse(null).

• callbackUrl

   final RunCreateParams.Builder callbackUrl(JsonField<String> callbackUrl)

  Sets Builder.callbackUrl to an arbitrary JSON value.

  You should usually call Builder.callbackUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• guidance

   final RunCreateParams.Builder guidance(String guidance)

  Additional guidance for this run

• guidance

   final RunCreateParams.Builder guidance(Optional<String> guidance)

  Alias for calling Builder.guidance with guidance.orElse(null).

• guidance

   final RunCreateParams.Builder guidance(JsonField<String> guidance)

  Sets Builder.guidance to an arbitrary JSON value.

  You should usually call Builder.guidance with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• model

   final RunCreateParams.Builder model(String model)

  Override the agent default model for this run

• model

   final RunCreateParams.Builder model(Optional<String> model)

  Alias for calling Builder.model with model.orElse(null).

• model

   final RunCreateParams.Builder model(JsonField<String> model)

  Sets Builder.model to an arbitrary JSON value.

  You should usually call Builder.model with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• objectIds

   final RunCreateParams.Builder objectIds(List<String> objectIds)

  Scope this run to specific vault object IDs. The agent will only be able to access these objects during execution.

• objectIds

   final RunCreateParams.Builder objectIds(Optional<List<String>> objectIds)

  Alias for calling Builder.objectIds with objectIds.orElse(null).

• objectIds

   final RunCreateParams.Builder objectIds(JsonField<List<String>> objectIds)

  Sets Builder.objectIds to an arbitrary JSON value.

  You should usually call Builder.objectIds with a well-typed List<String> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addObjectId

   final RunCreateParams.Builder addObjectId(String objectId)

  Adds a single String to objectIds.

• additionalBodyProperties

   final RunCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final RunCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final RunCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final RunCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final RunCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final RunCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final RunCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final RunCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final RunCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final RunCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final RunCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final RunCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final RunCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final RunCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final RunCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final RunCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final RunCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final RunCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final RunCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final RunCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final RunCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final RunCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final RunCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final RunCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final RunCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final RunCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final RunCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final RunCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final RunCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final RunCreateParams build()

  Returns an immutable instance of RunCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .agentId()
  .prompt()