transforms.api.Input

class transforms.api.Input(alias=None, branch=None, description=None, stop_propagating=None, stop_requiring=None, checks=None, failure_strategy=None, transaction_limit=None)

Specification for a transform dataset input.

This class is a concrete subclass of transforms.api.FoundryInputParam. See that page for base parameter semantics, including instance(), json_value, schema, and input_results.

For specifying multiple inputs, use transforms.api.InputSet.

• Parameters:
  • alias (str ↗ , optional) – Dataset resource identifier (RID), or the absolute Compass path of the dataset. If not specified, the parameter is unbound.
  • branch (str ↗ , optional) – Branch name to resolve the input dataset to. If not specified, it is resolved at build-time.
  • description (str ↗ , optional) – Input description.
  • stop_propagating (Markings , optional) – Security markings to stop propagating from this input.
  • stop_requiring (OrgMarkings , optional) – Organization markings that are no longer required on the output. Use OrgMarkings to specify the marking IDs and optional branches to which this applies.
  • checks (List [Check ] , Check) – One or more Check objects.
  • failure_strategy (str ↗ , optional) – Strategy used in case the input fails to update. Must be either continue or fail. If not specified, defaults to fail.
  • transaction_limit (int ↗ , optional) – The maximum number of transactions to read from an incremental input.

input_results(instance, **kwargs)

Generates a map from input RIDs to TransformsInputResult. Results are merged into a TransformJobResult.

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

History

• Changed in version 1.53.0: Now subclasses FoundryInputParam.

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.

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 input type from the resolved JSON value.

property schema

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