# flytekit.models.launch_plan

## Directory

### Classes

| Class | Description |
|-|-|
| [`Auth`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.models.launch_plan/page.md#flytekitmodelslaunch_planauth) |  |
| [`LaunchPlan`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.models.launch_plan/page.md#flytekitmodelslaunch_planlaunchplan) |  |
| [`LaunchPlanClosure`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.models.launch_plan/page.md#flytekitmodelslaunch_planlaunchplanclosure) |  |
| [`LaunchPlanMetadata`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.models.launch_plan/page.md#flytekitmodelslaunch_planlaunchplanmetadata) |  |
| [`LaunchPlanSpec`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.models.launch_plan/page.md#flytekitmodelslaunch_planlaunchplanspec) |  |
| [`LaunchPlanState`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.models.launch_plan/page.md#flytekitmodelslaunch_planlaunchplanstate) |  |

## flytekit.models.launch_plan.Auth

### Parameters

```python
class Auth(
    assumable_iam_role,
    kubernetes_service_account,
)
```
DEPRECATED. Do not use. Use flytekit.models.common.AuthRole instead
At most one of assumable_iam_role or kubernetes_service_account can be set.

| Parameter | Type | Description |
|-|-|-|
| `assumable_iam_role` |  | |
| `kubernetes_service_account` |  | |

### Properties

| Property | Type | Description |
|-|-|-|
| `assumable_iam_role` | `None` | The IAM role to execute the workflow with |
| `is_empty` | `None` |  |
| `kubernetes_service_account` | `None` | The kubernetes service account to execute the workflow with |

### Methods

| Method | Description |
|-|-|
| [`from_flyte_idl()`](#from_flyte_idl) |  |
| [`serialize_to_string()`](#serialize_to_string) |  |
| [`short_string()`](#short_string) |  |
| [`to_flyte_idl()`](#to_flyte_idl) |  |

#### from_flyte_idl()

```python
def from_flyte_idl(
    pb2_object,
)
```
| Parameter | Type | Description |
|-|-|-|
| `pb2_object` |  | |

**Returns:** Auth

#### serialize_to_string()

```python
def serialize_to_string()
```
#### short_string()

```python
def short_string()
```
**Returns:** Text

#### to_flyte_idl()

```python
def to_flyte_idl()
```
**Returns:** flyteidl.admin.launch_plan_pb2.Auth

## flytekit.models.launch_plan.LaunchPlan

### Parameters

```python
class LaunchPlan(
    id,
    spec,
    closure,
    auto_activate,
)
```
| Parameter | Type | Description |
|-|-|-|
| `id` |  | |
| `spec` |  | |
| `closure` |  | |
| `auto_activate` |  | |

### Properties

| Property | Type | Description |
|-|-|-|
| `closure` | `None` |  |
| `id` | `None` |  |
| `is_empty` | `None` |  |
| `should_auto_activate` | `None` |  |
| `spec` | `None` |  |

### Methods

| Method | Description |
|-|-|
| [`from_flyte_idl()`](#from_flyte_idl) |  |
| [`serialize_to_string()`](#serialize_to_string) |  |
| [`short_string()`](#short_string) |  |
| [`to_flyte_idl()`](#to_flyte_idl) |  |

#### from_flyte_idl()

```python
def from_flyte_idl(
    pb2_object,
)
```
| Parameter | Type | Description |
|-|-|-|
| `pb2_object` |  | |

**Returns:** LaunchPlan

#### serialize_to_string()

```python
def serialize_to_string()
```
#### short_string()

```python
def short_string()
```
**Returns:** Text

#### to_flyte_idl()

```python
def to_flyte_idl()
```
**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlan

## flytekit.models.launch_plan.LaunchPlanClosure

### Parameters

```python
class LaunchPlanClosure(
    state,
    expected_inputs,
    expected_outputs,
)
```
| Parameter | Type | Description |
|-|-|-|
| `state` |  | |
| `expected_inputs` |  | |
| `expected_outputs` |  | |

### Properties

| Property | Type | Description |
|-|-|-|
| `expected_inputs` | `None` |  |
| `expected_outputs` | `None` |  |
| `is_empty` | `None` |  |
| `state` | `None` |  |

### Methods

| Method | Description |
|-|-|
| [`from_flyte_idl()`](#from_flyte_idl) |  |
| [`serialize_to_string()`](#serialize_to_string) |  |
| [`short_string()`](#short_string) |  |
| [`to_flyte_idl()`](#to_flyte_idl) |  |

#### from_flyte_idl()

```python
def from_flyte_idl(
    pb2_object,
)
```
| Parameter | Type | Description |
|-|-|-|
| `pb2_object` |  | |

**Returns:** LaunchPlanClosure

#### serialize_to_string()

```python
def serialize_to_string()
```
#### short_string()

```python
def short_string()
```
**Returns:** Text

#### to_flyte_idl()

```python
def to_flyte_idl()
```
**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlanClosure

## flytekit.models.launch_plan.LaunchPlanMetadata

### Parameters

```python
class LaunchPlanMetadata(
    schedule,
    notifications,
    launch_conditions,
)
```
| Parameter | Type | Description |
|-|-|-|
| `schedule` |  | |
| `notifications` |  | |
| `launch_conditions` |  | Additional metadata for launching |

### Properties

| Property | Type | Description |
|-|-|-|
| `is_empty` | `None` |  |
| `launch_conditions` | `None` |  |
| `notifications` | `None` | List of notifications based on Execution status transitions |
| `schedule` | `None` | Schedule to execute the Launch Plan |

### Methods

| Method | Description |
|-|-|
| [`from_flyte_idl()`](#from_flyte_idl) |  |
| [`serialize_to_string()`](#serialize_to_string) |  |
| [`short_string()`](#short_string) |  |
| [`to_flyte_idl()`](#to_flyte_idl) | List of notifications based on Execution status transitions. |

#### from_flyte_idl()

```python
def from_flyte_idl(
    pb2_object,
)
```
| Parameter | Type | Description |
|-|-|-|
| `pb2_object` |  | |

**Returns:** LaunchPlanMetadata

#### serialize_to_string()

```python
def serialize_to_string()
```
#### short_string()

```python
def short_string()
```
**Returns:** Text

#### to_flyte_idl()

```python
def to_flyte_idl()
```
List of notifications based on Execution status transitions

**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlanMetadata

## flytekit.models.launch_plan.LaunchPlanSpec

### Parameters

```python
class LaunchPlanSpec(
    workflow_id,
    entity_metadata,
    default_inputs,
    fixed_inputs,
    labels: flytekit.models.common.Labels,
    annotations: flytekit.models.common.Annotations,
    auth_role: flytekit.models.common.AuthRole,
    raw_output_data_config: flytekit.models.common.RawOutputDataConfig,
    max_parallelism: typing.Optional[int],
    security_context: typing.Optional[flytekit.models.security.SecurityContext],
    overwrite_cache: typing.Optional[bool],
    concurrency_policy: typing.Optional[flytekit.models.concurrency.ConcurrencyPolicy],
)
```
The spec for a Launch Plan.

| Parameter | Type | Description |
|-|-|-|
| `workflow_id` |  | |
| `entity_metadata` |  | |
| `default_inputs` |  | |
| `fixed_inputs` |  | |
| `labels` | `flytekit.models.common.Labels` | |
| `annotations` | `flytekit.models.common.Annotations` | |
| `auth_role` | `flytekit.models.common.AuthRole` | |
| `raw_output_data_config` | `flytekit.models.common.RawOutputDataConfig` | |
| `max_parallelism` | `typing.Optional[int]` | |
| `security_context` | `typing.Optional[flytekit.models.security.SecurityContext]` | This can be used to add security information to a LaunchPlan, which will be used by every execution |
| `overwrite_cache` | `typing.Optional[bool]` | |
| `concurrency_policy` | `typing.Optional[flytekit.models.concurrency.ConcurrencyPolicy]` | |

### Properties

| Property | Type | Description |
|-|-|-|
| `annotations` | `None` | The annotations to execute the workflow with |
| `auth_role` | `None` | The authorization method with which to execute the workflow. |
| `concurrency_policy` | `None` | Concurrency settings for the launch plan. |
| `default_inputs` | `None` | Input values to be passed for the execution |
| `entity_metadata` | `None` |  |
| `fixed_inputs` | `None` | Fixed, non-overridable inputs for the Launch Plan |
| `is_empty` | `None` |  |
| `labels` | `None` | The labels to execute the workflow with |
| `max_parallelism` | `None` |  |
| `overwrite_cache` | `None` |  |
| `raw_output_data_config` | `None` | Where to store offloaded data like Blobs and Schemas |
| `security_context` | `None` |  |
| `workflow_id` | `None` | Unique identifier for the workflow in question |

### Methods

| Method | Description |
|-|-|
| [`from_flyte_idl()`](#from_flyte_idl) |  |
| [`serialize_to_string()`](#serialize_to_string) |  |
| [`short_string()`](#short_string) |  |
| [`to_flyte_idl()`](#to_flyte_idl) |  |

#### from_flyte_idl()

```python
def from_flyte_idl(
    pb2,
)
```
| Parameter | Type | Description |
|-|-|-|
| `pb2` |  | |

**Returns:** LaunchPlanSpec

#### serialize_to_string()

```python
def serialize_to_string()
```
#### short_string()

```python
def short_string()
```
**Returns:** Text

#### to_flyte_idl()

```python
def to_flyte_idl()
```
**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlanSpec

## flytekit.models.launch_plan.LaunchPlanState

### Methods

| Method | Description |
|-|-|
| [`enum_to_string()`](#enum_to_string) |  |

#### enum_to_string()

```python
def enum_to_string(
    val,
)
```
| Parameter | Type | Description |
|-|-|-|
| `val` |  | |

**Returns:** Text

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/flytekit-sdk/packages/flytekit.models.launch_plan.md
**HTML**: https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.models.launch_plan/