Skip to content

delete_flow

Operation

delete_flow

delete_flow(request: DeleteFlowInput | DeleteFlowInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteFlowInputDict]) -> DeleteFlowOutput

Deletes a flow.

Parameters:

Name Type Description Default
request DeleteFlowInput | DeleteFlowInputDict | 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[DeleteFlowInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteFlowOutput

An instance of DeleteFlowOutput.

delete_flow async

delete_flow(request: DeleteFlowInput | DeleteFlowInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteFlowInputDict]) -> DeleteFlowOutput

Deletes a flow.

Parameters:

Name Type Description Default
request DeleteFlowInput | DeleteFlowInputDict | 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[DeleteFlowInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteFlowOutput

An instance of DeleteFlowOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteFlowInputDict

Bases: TypedDict

Dictionary form of DeleteFlowInput.

Attributes

flow_identifier instance-attribute
flow_identifier: Required[str]

The unique identifier of the flow.

skip_resource_in_use_check instance-attribute
skip_resource_in_use_check: bool | None

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

DeleteFlowInput dataclass

Bases: _SerdeShape

Dataclass for DeleteFlowInput structure.

Attributes

flow_identifier class-attribute instance-attribute
flow_identifier: str | None = ...

The unique identifier of the flow.

skip_resource_in_use_check class-attribute instance-attribute
skip_resource_in_use_check: bool = ...

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Output

DeleteFlowOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteFlowOutput structure.

Attributes

id instance-attribute
id: str

The unique identifier of the flow.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.