Package ai.extend.resources.workflowruns.requests

Class WorkflowRunsUpdateRequest.Builder

java.lang.Object

ai.extend.resources.workflowruns.requests.WorkflowRunsUpdateRequest.Builder

Enclosing class:

WorkflowRunsUpdateRequest

public static final class WorkflowRunsUpdateRequest.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
WorkflowRunsUpdateRequest	build()
WorkflowRunsUpdateRequest.Builder	extendWorkspaceId(java.lang.String extendWorkspaceId)
WorkflowRunsUpdateRequest.Builder	extendWorkspaceId(java.util.Optional<java.lang.String> extendWorkspaceId)	The workspace ID to target.
WorkflowRunsUpdateRequest.Builder	from(WorkflowRunsUpdateRequest other)
WorkflowRunsUpdateRequest.Builder	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
WorkflowRunsUpdateRequest.Builder	metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)	A metadata object that can be assigned to a specific WorkflowRun.
WorkflowRunsUpdateRequest.Builder	name(java.lang.String name)
WorkflowRunsUpdateRequest.Builder	name(java.util.Optional<java.lang.String> name)	An optional name that can be assigned to a specific WorkflowRun

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public WorkflowRunsUpdateRequest.Builder from(WorkflowRunsUpdateRequest other)

extendWorkspaceId

public WorkflowRunsUpdateRequest.Builder extendWorkspaceId(java.util.Optional<java.lang.String> extendWorkspaceId)

The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.

extendWorkspaceId

public WorkflowRunsUpdateRequest.Builder extendWorkspaceId(java.lang.String extendWorkspaceId)

name

public WorkflowRunsUpdateRequest.Builder name(java.util.Optional<java.lang.String> name)

An optional name that can be assigned to a specific WorkflowRun

name

public WorkflowRunsUpdateRequest.Builder name(java.lang.String name)

metadata

public WorkflowRunsUpdateRequest.Builder metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)

A metadata object that can be assigned to a specific WorkflowRun. If metadata already exists on this WorkflowRun, the newly incoming metadata will be merged with the existing metadata, with the incoming metadata taking field precedence.

You can include any arbitrary key : value pairs in this object.

To categorize workflow runs for billing and usage tracking, include extend:usage_tags with an array of string values (e.g., {"extend:usage_tags": ["production", "team-eng", "customer-123"]}). Tags must contain only alphanumeric characters, hyphens, and underscores; any special characters will be automatically removed.

metadata

public WorkflowRunsUpdateRequest.Builder metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)

build

public WorkflowRunsUpdateRequest build()