# 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) {#transforms.api.Input}

Specification for a transform dataset input.

This class is a concrete subclass of [`transforms.api.FoundryInputParam`](../api-foundryinputparam/index.md#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`](../api-inputset/index.md#transforms.api.InputSet).

* **Parameters:**
  * **alias** ([*str* ↗](https://docs.python.org/3/library/stdtypes.html#str) *,* *optional*) – Dataset resource identifier (RID), or the absolute Compass path of the dataset. If not specified, the parameter is unbound.
  * **branch** ([*str* ↗](https://docs.python.org/3/library/stdtypes.html#str) *,* *optional*) – Branch name to resolve the input dataset to. If not specified, it is resolved at build-time.
  * **description** ([*str* ↗](https://docs.python.org/3/library/stdtypes.html#str) *,* *optional*) – Input description.
  * **stop\_propagating** ([*Markings*](../api-markings/index.md#transforms.api.Markings) *,* *optional*) – Security markings to stop propagating from this input.
  * **stop\_requiring** ([*OrgMarkings*](../api-orgmarkings/index.md#transforms.api.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*](../api-check/index.md#transforms.api.Check) *]* *,* [*Check*](../api-check/index.md#transforms.api.Check)) – One or more [`Check`](../api-check/index.md#transforms.api.Check) objects.
  * **failure\_strategy** ([*str* ↗](https://docs.python.org/3/library/stdtypes.html#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* ↗](https://docs.python.org/3/library/functions.html#int) *,* *optional*) – The maximum number of transactions to read from an incremental input.

### input\_results(instance, \*\*kwargs) {#transforms.api.Input.input\_results}

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](../api-foundryinputparam/index.md#transforms.api.FoundryInputParam).

### *static* instance(context, json\_value) {#transforms.api.Input.instance}

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*](../api-paramcontext/index.md#transforms.api.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 {#transforms.api.Input.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) {#transforms.api.Input.lightweight\_instance}

Instantiate an input type from the resolved JSON value.

### *property* schema {#transforms.api.Input.schema}

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