validate_flow_definition¶
Operation¶
async
¶
validate_flow_definition(input: ValidateFlowDefinitionInput, plugins: list[Plugin] | None = None) -> ValidateFlowDefinitionOutput
Validates the definition of a flow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ValidateFlowDefinitionInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
ValidateFlowDefinitionOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ValidateFlowDefinitionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
definition: FlowDefinition | None = field(repr=False, default=None)
The definition of a flow to validate.
Output¶
dataclass
¶
Dataclass for ValidateFlowDefinitionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)
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.
instance-attribute
¶
validations: list[FlowValidation]
Contains an array of objects, each of which contains an error identified by validation.