validate_flow_definition¶
Operation¶
validate_flow_definition
¶
validate_flow_definition(request: ValidateFlowDefinitionInput | ValidateFlowDefinitionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ValidateFlowDefinitionInputDict]) -> ValidateFlowDefinitionOutput
Validates the definition of a flow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ValidateFlowDefinitionInput | ValidateFlowDefinitionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ValidateFlowDefinitionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ValidateFlowDefinitionOutput
|
An instance of |
validate_flow_definition
async
¶
validate_flow_definition(request: ValidateFlowDefinitionInput | ValidateFlowDefinitionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ValidateFlowDefinitionInputDict]) -> ValidateFlowDefinitionOutput
Validates the definition of a flow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ValidateFlowDefinitionInput | ValidateFlowDefinitionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ValidateFlowDefinitionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ValidateFlowDefinitionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ValidateFlowDefinitionInputDict
¶
Bases: TypedDict
Dictionary form of ValidateFlowDefinitionInput.
Attributes¶
definition
instance-attribute
¶
definition: Required[FlowDefinition | FlowDefinitionDict]
The definition of a flow to validate.
ValidateFlowDefinitionInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ValidateFlowDefinitionInput structure.
Attributes¶
definition
class-attribute
instance-attribute
¶
definition: FlowDefinition | None = ...
The definition of a flow to validate.
Output¶
ValidateFlowDefinitionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ValidateFlowDefinitionOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
validations
instance-attribute
¶
validations: list[FlowValidation]
Contains an array of objects, each of which contains an error identified by validation.