Search documentation
karat

+

K

User Documentation ↗

transforms.api.InputSet

class transforms.api.InputSet(aliases=None, description=None)

Specification for a list of transform inputs.

  • Parameters:
    • aliases (list of str , optional) – List of dataset resource identifiers (RIDs), or the absolute Compass paths of the datasets. If not specified, the parameter is unbound. Empty lists are not allowed.
    • description (str , optional) – Input set description. Note that this feature is not implemented yet.

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

  • Added in version 1.53.0.

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.

property schema

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