Skip to content

voplica.types.workflow.common

The protobuf package voplica.types.workflow.common: 0 services, 6 messages and 7 enums, defined in voplica/types/workflow/common/gpu_tier.proto, voplica/types/workflow/common/node_executor_type.proto, voplica/types/workflow/common/step_error_hanling.proto, voplica/types/workflow/common/step_exec_config.proto, voplica/types/workflow/common/value_cast_mode.proto, voplica/types/workflow/common/workflow_charge_disposition.proto, voplica/types/workflow/common/workflow_content_publish_policy.proto, voplica/types/workflow/common/workflow_content_publish_stage.proto, voplica/types/workflow/common/workflow_content_registration.proto, voplica/types/workflow/common/workflow_termination_reason.proto.

Field Number Type Label Description
vram_gb 1 uint32
Field Number Type Label Description
iteration_timeout_ms 1 uint64 optional Max time in ms a single Step iteration is allowed to run.
max_iteration_retries 2 uint32 optional How many times failed iteration can be retried
max_iterations 3 uint64 optional Max amount of successful iterations
step_error_handling_type 4 StepErrorHandlingType optional What to do if Step failed Notice, a Step Iteration is considered to be failed only after max_iteration_retries. I.e. if max_iteration_retries = 3, and the Step execution failed 2 times - it’s not considered to be failed yet. It will be considered as failed if it fails third time or will be considered as successfully completed if it succeeds on the third time.
content_registration 5 WorkflowContentRegistration optional What produced content from this Step to register for the user. This automatically triggers file conversion via the default conversion process based on the target asset type. The asset then becomes available in generated content in user cabinet.

Controls how generated content is published during workflow execution.

When a workflow step marked as publishable (via WorkflowStepContentConfig) completes, the system uses this policy to determine whether and how to create content records.

If not provided in ExecuteWorkflowRequest, the default behavior is:

  • enabled = true (content is auto-created for publishable steps)
  • auto_publish_final = false (all content starts as DRAFT)
  • visibility and MPA rating inherited from the workflow execution
Field Number Type Label Description
publish_stage 1 WorkflowContentPublishStage optional If unspecified - if not set, inherits from the workflow variant default_publish_stage.
default_visibility 2 voplica.types.base.VisibilityType optional Visibility for auto-created content. If not set, inherits from the workflow execution’s visibility setting.
expected_mpa_rating 3 voplica.types.base.MPARating optional MPA rating for auto-created content. If the content is detected to be produced with higher-level mpa_rating this content will not be auto-published. If not set - allow any mpa_rating publishing.
default_provenance_display_level 4 voplica.types.content.ProvenanceDisplayLevel optional Provenance display level for auto-created content. If not set, defaults to FULL (all provenance metadata is visible to everyone).
Field Number Type Label Description
asset_type 1 voplica.types.base.AssetType optional Explicit asset type for the files found via automatic FileInfo lookup. If not set, the system infers the asset types from the source files (e.g., image files → IMAGE_ASSET, video files → VIDEO_ASSET).
Field Number Type Label Description
file_id_path 1 string Path example: foo.bar.my_file_id If the provided path has any arrays in-between - it simply means that we are referencing multiple file ids and each file id will be treated as a separate Asset
asset_type 2 voplica.types.base.AssetType optional Explicit asset type for the content. If not set, the system infers the asset type from the source file (e.g., image file → IMAGE_ASSET, video file → VIDEO_ASSET).
Field Number Type Label Description
auto_registration 1 WorkflowContentAutoRegistration optional Configuration for automated FileInfo registration. When not provided - it means disabled. If provided it will lookup at output of the Step and recursively start searching for any FileInfo produced in the output. For any found FileInfo it will get id of the file and use it to assemble GeneratedAsset for the user. Users can easily post Generated Assets or search all Generated Assets in their cabinet.
path_registrations 2 WorkflowContentPathRegistration repeated Sometimes a Step may produce a simple file id String, and not a complete FileInfo. In such cases, we should manually provide paths to those file ids that should be registered.

GPU tier - applicable only to Activities

Name Number Description
WORKFLOW_GPU_TIER_UNSPECIFIED 0
NO_GPU 1
S_GPU 2 Step will be scheduled on the machine with at least 24 GB of vRAM
M_GPU 3 Step will be scheduled on the machine with at least 48 GB of vRAM
L_GPU 4 Step will be scheduled on the machine with at least 80 GB of vRAM
Name Number Description
EXECUTOR_TYPE_UNSPECIFIED 0
ACTIVITY 1
ORCHESTRATOR 2
CONTAINER 3
EXTERNAL 4 Orchestrator makes an HTTP call or posts to a message bus.

Determines what happens when a Step fails (after all retries are exhausted).

Name Number Description
STEP_ERROR_HANDLING_TYPE_UNSPECIFIED 0
FAIL_WORKFLOW 1 Fails the whole workflow. Useful if the Step is critical and other Steps depend on its successful execution.
INCREMENT_ITERATION_AND_SKIP 2 Ignores an error, increments current_iteration as usual, but outputs nothing (unresolvable output). Useful for non-critical Steps. For example, often times ContentPublishing is considered as non-critical or some informative notification steps are considered non-critical.
Name Number Description
WORKFLOW_VALUE_CAST_MODE_UNSPECIFIED 0
REQUIRE_SAME_VALUE_SPEC 1
CONVERT_ANY_TO_STRUCT 2
CONVERT_ANY_TO_JSON_STRING 3
Name Number Description
WORKFLOW_CHARGE_DISPOSITION_UNSPECIFIED 0
WORKFLOW_CHARGE_DISPOSITION_CHARGED 1 The step’s charges stand: a user-caused, provider-billed or unknown failure class, or nothing keyed to this step to reverse.
WORKFLOW_CHARGE_DISPOSITION_REVERSED 2 A platform failure class: the step’s charges were reversed (credits_reversed_milli).
WORKFLOW_CHARGE_DISPOSITION_WOULD_REVERSE 3 The same decision recorded while nothing moves (the switch in LOG_ONLY): credits_reversed_milli is what WOULD have been reversed and is never money returned.
WORKFLOW_CHARGE_DISPOSITION_NOT_APPLIED 4 A reversal was decided and payments did not apply it (refused, unavailable, or a payments without the rpc): the step’s charges stand.
WORKFLOW_CHARGE_DISPOSITION_NOT_CHARGED 5

Indicates what assets should be auto-published during Workflow Execution

Name Number Description
WORKFLOW_CONTENT_PUBLISH_STAGE_UNSPECIFIED 0
STAGE_NONE 1 Do not publish any assets in the current Workflow Execution
STAGE_ROOT_LAST_ASSET 2 Publish only the latest produced asset by any Step in Root Workflow Execution. This will be evaluated when the Workflow Execution executed all Steps and turning into COMPLETE status.
STAGE_ROOT_ONLY_ASSETS 3 Publish all assets that were produced in the Root Workflow Execution.
STAGE_ALL_ASSETS 4 Publish all produced assets - including all assets in Child Workflows Executions.
Name Number Description
TERMINATION_REASON_UNSPECIFIED 0
COMPLETED_SUCCESSFULLY 1
MAX_ITERATIONS_REACHED 2
NO_NEW_OUTPUTS 3
CONDITION_MET 4
MANUAL_STOP 5
TIMEOUT 6
CRITICAL_STEP_FAILED 7
RESOURCE_LIMIT_EXCEEDED 8