transforms.api.FoundryOutputParam

class transforms.api.FoundryOutputParam(aliases, type='foundry', description=None, properties=None)

A base class for transforms output parameters. Not intended for direct use. See transforms.api.Output for an example of concrete usage.

All aliases are resolved and added in the output specs section of JobSpec. Will not pass a defaultPath to the graph dependency if the alias is a valid resource identifier (RID).

• Parameters:
  • aliases (list ↗ of str ↗) – A list of absolute Compass paths or dataset RIDs.
  • description (str ↗ , optional) – Parameter description.
  • properties (dict ↗ , optional) – Optional properties that get written to the build graph output reference.
  • type (str ↗ , optional) – The output dataset type.

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

• Added in version 1.53.0.

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.

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.