Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions docs/v3/api-ref/cli/flow-run.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,61 @@ Cancel a flow run by ID.



## `prefect flow-run retry`



```command
prefect flow-run retry [OPTIONS] ID_OR_NAME
```



<Info>
Retry a failed or completed flow run.

The flow run can be specified by either its UUID or its name. If multiple
flow runs have the same name, you must use the UUID to disambiguate.

If the flow run has an associated deployment, it will be scheduled for retry
and a worker will pick it up. If there is no deployment, you must provide
an --entrypoint to the flow code, and the flow will execute locally.


Examples:
\$ prefect flow-run retry abc123-def456-7890-...
\$ prefect flow-run retry my-flow-run-name
\$ prefect flow-run retry abc123 --entrypoint ./flows/my_flow.py:my_flow
</Info>






<AccordionGroup>


<Accordion title="Arguments" defaultOpen>
<ResponseField name="ID_OR_NAME" type="string" required>
The flow run ID (UUID) or name to retry. \[required]
</ResponseField>
</Accordion>



<Accordion title="Options" defaultOpen>

<ResponseField name="--entrypoint">
The path to a file containing the flow to run, and the name of the flow function, in the format `path/to/file.py:flow_function_name`. Required if the flow run does not have an associated deployment.
</ResponseField>

</Accordion>

</AccordionGroup>



## `prefect flow-run logs`


Expand Down
55 changes: 55 additions & 0 deletions docs/v3/api-ref/cli/flow-runs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,61 @@ Cancel a flow run by ID.



## `prefect flow-runs retry`



```command
prefect flow-runs retry [OPTIONS] ID_OR_NAME
```



<Info>
Retry a failed or completed flow run.

The flow run can be specified by either its UUID or its name. If multiple
flow runs have the same name, you must use the UUID to disambiguate.

If the flow run has an associated deployment, it will be scheduled for retry
and a worker will pick it up. If there is no deployment, you must provide
an --entrypoint to the flow code, and the flow will execute locally.


Examples:
\$ prefect flow-run retry abc123-def456-7890-...
\$ prefect flow-run retry my-flow-run-name
\$ prefect flow-run retry abc123 --entrypoint ./flows/my_flow.py:my_flow
</Info>






<AccordionGroup>


<Accordion title="Arguments" defaultOpen>
<ResponseField name="ID_OR_NAME" type="string" required>
The flow run ID (UUID) or name to retry. \[required]
</ResponseField>
</Accordion>



<Accordion title="Options" defaultOpen>

<ResponseField name="--entrypoint">
The path to a file containing the flow to run, and the name of the flow function, in the format `path/to/file.py:flow_function_name`. Required if the flow run does not have an associated deployment.
</ResponseField>

</Accordion>

</AccordionGroup>



## `prefect flow-runs logs`


Expand Down
10 changes: 5 additions & 5 deletions docs/v3/api-ref/python/prefect-blocks-notifications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ custom_webhook_block.notify("Hello from Prefect!")

**Methods:**

#### `block_initialization` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L900" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
#### `block_initialization` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L906" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python
block_initialization(self) -> None
Expand All @@ -407,7 +407,7 @@ Else, it returns a default logger labeled with the class's name.
- The run logger or a default logger with the class's name.


#### `notify` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L919" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
#### `notify` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L925" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python
notify(self, body: str, subject: str | None = None) -> None
Expand Down Expand Up @@ -436,7 +436,7 @@ Context manager that, while active, causes the block to raise errors if it
encounters a failure sending notifications.


### `SendgridEmail` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L933" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
### `SendgridEmail` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L939" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>


Enables sending notifications via any sendgrid account.
Expand All @@ -456,7 +456,7 @@ sendgrid_block.notify("Hello from Prefect!")

**Methods:**

#### `block_initialization` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L978" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
#### `block_initialization` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L984" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python
block_initialization(self) -> None
Expand All @@ -468,7 +468,7 @@ block_initialization(self) -> None
block_initialization(self) -> None
```

#### `notify` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L1003" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
#### `notify` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/notifications.py#L1009" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python
notify(self, body: str, subject: str | None = None)
Expand Down
8 changes: 8 additions & 0 deletions docs/v3/api-ref/python/prefect-blocks-redis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ sidebarTitle: redis

Block used to interact with Redis as a filesystem

**Attributes:**
- `host`: The value to store.
- `port`: The value to store.
- `db`: The value to store.
- `username`: The value to store.
- `password`: The value to store.
- `connection_string`: The value to store.


**Methods:**

Expand Down
3 changes: 3 additions & 0 deletions docs/v3/api-ref/python/prefect-blocks-system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ sidebarTitle: system
A block that represents a secret value. The value stored in this block will be obfuscated when
this block is viewed or edited in the UI.

**Attributes:**
- `value`: A value that should be kept secret.


**Methods:**

Expand Down
Loading