transforms.api.Output

class transforms.api.Output(alias=None, sever_permissions=False, description=None, checks=None)

Specification for a transform output.

• Parameters:

  • alias (str ↗ , optional) – Dataset resource identifier (RID) or the absolute Compass path of the dataset. If not specified, the parameter is unbound.

  • sever_permissions (bool ↗ , optional) –

    If True, severs the dataset’s permissions from their input’s permissions. Ignored if parameter is unbound.

    Deprecated since version 3.85.0: Use transforms.api.Input.stop_propagating or transforms.api.Input.stop_requiring instead.

  • description (str ↗ , optional) – Output description. Note that this feature is not implemented yet.

  • checks (List [Check ] , Check) – One or more Check objects.

static instance(context, json_value)

Creates a parameter instance using the raw JSON value from JobSpec parameters and specific context.

The return value is injected in the transform compute function.

• Parameters:
  • context (ParamContext) – A context object with properties that might be required for creating an instance.
  • json_value (any) – Any raw value deserialized from JobSpec parameters.

History

• Changed in version 1.53.0: Now subclasses FoundryOutputParam

property json_value

Returns the JSON value for this parameter to put in JobSpec.

If the return value is None, the parameter is considered unbound. If any transform’s parameter is unbound, the transform is considered to be unbound. For unbound transforms, the JobSpec is not published.

static lightweight_instance(_context, json_value)

Instantiate an output type from the resolved JSON value.

output_results(instance, **kwargs)

Generates a map from output RIDs to TransformsOutputResult. Results are merged into a TransformJobResult.

• Parameters: instance – An object of the type generated by instance().

property schema

Returns JSON schema for parameters of this type. Must return a valid JSON schema.