0.1.dev2184+g1e0cbe7.d20250401
flytekit.models.launch_plan
Directory
Classes
| Class | Description |
|---|---|
Auth |
|
LaunchPlan |
|
LaunchPlanClosure |
|
LaunchPlanMetadata |
|
LaunchPlanSpec |
|
LaunchPlanState |
flytekit.models.launch_plan.Auth
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 |
|---|---|
assumable_iam_role |
|
kubernetes_service_account |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: Auth| Parameter | Type |
|---|---|
pb2_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl():rtype: flyteidl.admin.launch_plan_pb2.Auth
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
assumable_iam_role |
The IAM role to execute the workflow with :rtype: Text |
|
is_empty |
||
kubernetes_service_account |
The kubernetes service account to execute the workflow with :rtype: Text |
flytekit.models.launch_plan.LaunchPlan
class LaunchPlan(
id,
spec,
closure,
auto_activate,
)| Parameter | Type |
|---|---|
id |
|
spec |
|
closure |
|
auto_activate |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: LaunchPlan| Parameter | Type |
|---|---|
pb2_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl():rtype: flyteidl.admin.launch_plan_pb2.LaunchPlan
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
closure |
:rtype: LaunchPlanClosure |
|
id |
:rtype: flytekit.models.core.identifier.Identifier |
|
is_empty |
||
should_auto_activate |
||
spec |
:rtype: LaunchPlanSpec |
flytekit.models.launch_plan.LaunchPlanClosure
class LaunchPlanClosure(
state,
expected_inputs,
expected_outputs,
)| Parameter | Type |
|---|---|
state |
|
expected_inputs |
|
expected_outputs |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: LaunchPlanClosure| Parameter | Type |
|---|---|
pb2_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl():rtype: flyteidl.admin.launch_plan_pb2.LaunchPlanClosure
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
expected_inputs |
:rtype: flytekit.models.interface.ParameterMap |
|
expected_outputs |
:rtype: flytekit.models.interface.VariableMap |
|
is_empty |
||
state |
:rtype: LaunchPlanState |
flytekit.models.launch_plan.LaunchPlanMetadata
class LaunchPlanMetadata(
schedule,
notifications,
launch_conditions,
)| Parameter | Type |
|---|---|
schedule |
|
notifications |
|
launch_conditions |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
List of notifications based on Execution status transitions. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: LaunchPlanMetadata| Parameter | Type |
|---|---|
pb2_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl()List of notifications based on Execution status transitions :rtype: flyteidl.admin.launch_plan_pb2.LaunchPlanMetadata
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
||
launch_conditions |
||
notifications |
List of notifications based on Execution status transitions :rtype: list[flytekit.models.common.Notification] |
|
schedule |
Schedule to execute the Launch Plan :rtype: flytekit.models.schedule.Schedule |
flytekit.models.launch_plan.LaunchPlanSpec
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],
)The spec for a Launch Plan.
| Parameter | Type |
|---|---|
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] |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2,
) -> e: LaunchPlanSpec| Parameter | Type |
|---|---|
pb2 |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl():rtype: flyteidl.admin.launch_plan_pb2.LaunchPlanSpec
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
annotations |
The annotations to execute the workflow with :rtype: flytekit.models.common.Annotations |
|
auth_role |
The authorization method with which to execute the workflow. :rtype: flytekit.models.common.AuthRole |
|
default_inputs |
Input values to be passed for the execution :rtype: flytekit.models.interface.ParameterMap |
|
entity_metadata |
:rtype: LaunchPlanMetadata |
|
fixed_inputs |
Fixed, non-overridable inputs for the Launch Plan :rtype: flytekit.models.literals.LiteralMap |
|
is_empty |
||
labels |
The labels to execute the workflow with :rtype: flytekit.models.common.Labels |
|
max_parallelism |
||
overwrite_cache |
||
raw_output_data_config |
Where to store offloaded data like Blobs and Schemas :rtype: flytekit.models.common.RawOutputDataConfig |
|
security_context |
||
workflow_id |
Unique identifier for the workflow in question :rtype: flytekit.models.core.identifier.Identifier |
flytekit.models.launch_plan.LaunchPlanState
Methods
| Method | Description |
|---|---|
enum_to_string() |
. |
enum_to_string()
def enum_to_string(
val,
) -> e: Text| Parameter | Type |
|---|---|
val |