Package flyteidl.admin
Interface ExecutionOuterClass.ExecutionSpecOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ExecutionOuterClass.ExecutionSpec,ExecutionOuterClass.ExecutionSpec.Builder
- Enclosing class:
- ExecutionOuterClass
public static interface ExecutionOuterClass.ExecutionSpecOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Common.AnnotationsgetAnnotations()Annotations to apply to the execution resource.Common.AnnotationsOrBuildergetAnnotationsOrBuilder()Annotations to apply to the execution resource.Common.AuthRolegetAuthRole()Deprecated.flyteidl.admin.ExecutionSpec.auth_role is deprecated.Common.AuthRoleOrBuildergetAuthRoleOrBuilder()Deprecated.ClusterAssignmentOuterClass.ClusterAssignmentgetClusterAssignment()Controls how to select an available cluster on which this execution should run.ClusterAssignmentOuterClass.ClusterAssignmentOrBuildergetClusterAssignmentOrBuilder()Controls how to select an available cluster on which this execution should run.booleangetDisableAll()This should be set to true if all notifications are intended to be disabled for this execution.Literals.LiteralMapgetInputs()Deprecated.flyteidl.admin.ExecutionSpec.inputs is deprecated.Literals.LiteralMapOrBuildergetInputsOrBuilder()Deprecated.com.google.protobuf.BoolValuegetInterruptible()Allows for the interruptible flag of a workflow to be overwritten for a single execution.com.google.protobuf.BoolValueOrBuildergetInterruptibleOrBuilder()Allows for the interruptible flag of a workflow to be overwritten for a single execution.Common.LabelsgetLabels()Labels to apply to the execution resource.Common.LabelsOrBuildergetLabelsOrBuilder()Labels to apply to the execution resource.IdentifierOuterClass.IdentifiergetLaunchPlan()Launch plan to be executedIdentifierOuterClass.IdentifierOrBuildergetLaunchPlanOrBuilder()Launch plan to be executedintgetMaxParallelism()Controls the maximum number of task nodes that can be run in parallel for the entire workflow.ExecutionOuterClass.ExecutionMetadatagetMetadata()Metadata for the executionExecutionOuterClass.ExecutionMetadataOrBuildergetMetadataOrBuilder()Metadata for the executionExecutionOuterClass.ExecutionSpec.NotificationOverridesCasegetNotificationOverridesCase()ExecutionOuterClass.NotificationListgetNotifications()List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan.ExecutionOuterClass.NotificationListOrBuildergetNotificationsOrBuilder()List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan.Execution.QualityOfServicegetQualityOfService()Indicates the runtime priority of the execution.Execution.QualityOfServiceOrBuildergetQualityOfServiceOrBuilder()Indicates the runtime priority of the execution.Common.RawOutputDataConfiggetRawOutputDataConfig()User setting to configure where to store offloaded data (i.e.Common.RawOutputDataConfigOrBuildergetRawOutputDataConfigOrBuilder()User setting to configure where to store offloaded data (i.e.Security.SecurityContextgetSecurityContext()Optional: security context override to apply this execution.Security.SecurityContextOrBuildergetSecurityContextOrBuilder()Optional: security context override to apply this execution.booleanhasAnnotations()Annotations to apply to the execution resource.booleanhasAuthRole()Deprecated.flyteidl.admin.ExecutionSpec.auth_role is deprecated.booleanhasClusterAssignment()Controls how to select an available cluster on which this execution should run.booleanhasDisableAll()This should be set to true if all notifications are intended to be disabled for this execution.booleanhasInputs()Deprecated.flyteidl.admin.ExecutionSpec.inputs is deprecated.booleanhasInterruptible()Allows for the interruptible flag of a workflow to be overwritten for a single execution.booleanhasLabels()Labels to apply to the execution resource.booleanhasLaunchPlan()Launch plan to be executedbooleanhasMetadata()Metadata for the executionbooleanhasNotifications()List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan.booleanhasQualityOfService()Indicates the runtime priority of the execution.booleanhasRawOutputDataConfig()User setting to configure where to store offloaded data (i.e.booleanhasSecurityContext()Optional: security context override to apply this execution.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
hasLaunchPlan
boolean hasLaunchPlan()
Launch plan to be executed
.flyteidl.core.Identifier launch_plan = 1;- Returns:
- Whether the launchPlan field is set.
-
getLaunchPlan
IdentifierOuterClass.Identifier getLaunchPlan()
Launch plan to be executed
.flyteidl.core.Identifier launch_plan = 1;- Returns:
- The launchPlan.
-
getLaunchPlanOrBuilder
IdentifierOuterClass.IdentifierOrBuilder getLaunchPlanOrBuilder()
Launch plan to be executed
.flyteidl.core.Identifier launch_plan = 1;
-
hasInputs
@Deprecated boolean hasInputs()
Deprecated.flyteidl.admin.ExecutionSpec.inputs is deprecated. See flyteidl/admin/execution.proto;l=248Input values to be passed for the execution
.flyteidl.core.LiteralMap inputs = 2 [deprecated = true];- Returns:
- Whether the inputs field is set.
-
getInputs
@Deprecated Literals.LiteralMap getInputs()
Deprecated.flyteidl.admin.ExecutionSpec.inputs is deprecated. See flyteidl/admin/execution.proto;l=248Input values to be passed for the execution
.flyteidl.core.LiteralMap inputs = 2 [deprecated = true];- Returns:
- The inputs.
-
getInputsOrBuilder
@Deprecated Literals.LiteralMapOrBuilder getInputsOrBuilder()
Deprecated.Input values to be passed for the execution
.flyteidl.core.LiteralMap inputs = 2 [deprecated = true];
-
hasMetadata
boolean hasMetadata()
Metadata for the execution
.flyteidl.admin.ExecutionMetadata metadata = 3;- Returns:
- Whether the metadata field is set.
-
getMetadata
ExecutionOuterClass.ExecutionMetadata getMetadata()
Metadata for the execution
.flyteidl.admin.ExecutionMetadata metadata = 3;- Returns:
- The metadata.
-
getMetadataOrBuilder
ExecutionOuterClass.ExecutionMetadataOrBuilder getMetadataOrBuilder()
Metadata for the execution
.flyteidl.admin.ExecutionMetadata metadata = 3;
-
hasNotifications
boolean hasNotifications()
List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan. When this list is empty, the notifications defined for the launch plan will be applied.
.flyteidl.admin.NotificationList notifications = 5;- Returns:
- Whether the notifications field is set.
-
getNotifications
ExecutionOuterClass.NotificationList getNotifications()
List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan. When this list is empty, the notifications defined for the launch plan will be applied.
.flyteidl.admin.NotificationList notifications = 5;- Returns:
- The notifications.
-
getNotificationsOrBuilder
ExecutionOuterClass.NotificationListOrBuilder getNotificationsOrBuilder()
List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan. When this list is empty, the notifications defined for the launch plan will be applied.
.flyteidl.admin.NotificationList notifications = 5;
-
hasDisableAll
boolean hasDisableAll()
This should be set to true if all notifications are intended to be disabled for this execution.
bool disable_all = 6;- Returns:
- Whether the disableAll field is set.
-
getDisableAll
boolean getDisableAll()
This should be set to true if all notifications are intended to be disabled for this execution.
bool disable_all = 6;- Returns:
- The disableAll.
-
hasLabels
boolean hasLabels()
Labels to apply to the execution resource.
.flyteidl.admin.Labels labels = 7;- Returns:
- Whether the labels field is set.
-
getLabels
Common.Labels getLabels()
Labels to apply to the execution resource.
.flyteidl.admin.Labels labels = 7;- Returns:
- The labels.
-
getLabelsOrBuilder
Common.LabelsOrBuilder getLabelsOrBuilder()
Labels to apply to the execution resource.
.flyteidl.admin.Labels labels = 7;
-
hasAnnotations
boolean hasAnnotations()
Annotations to apply to the execution resource.
.flyteidl.admin.Annotations annotations = 8;- Returns:
- Whether the annotations field is set.
-
getAnnotations
Common.Annotations getAnnotations()
Annotations to apply to the execution resource.
.flyteidl.admin.Annotations annotations = 8;- Returns:
- The annotations.
-
getAnnotationsOrBuilder
Common.AnnotationsOrBuilder getAnnotationsOrBuilder()
Annotations to apply to the execution resource.
.flyteidl.admin.Annotations annotations = 8;
-
hasSecurityContext
boolean hasSecurityContext()
Optional: security context override to apply this execution.
.flyteidl.core.SecurityContext security_context = 10;- Returns:
- Whether the securityContext field is set.
-
getSecurityContext
Security.SecurityContext getSecurityContext()
Optional: security context override to apply this execution.
.flyteidl.core.SecurityContext security_context = 10;- Returns:
- The securityContext.
-
getSecurityContextOrBuilder
Security.SecurityContextOrBuilder getSecurityContextOrBuilder()
Optional: security context override to apply this execution.
.flyteidl.core.SecurityContext security_context = 10;
-
hasAuthRole
@Deprecated boolean hasAuthRole()
Deprecated.flyteidl.admin.ExecutionSpec.auth_role is deprecated. See flyteidl/admin/execution.proto;l=276Optional: auth override to apply this execution.
.flyteidl.admin.AuthRole auth_role = 16 [deprecated = true];- Returns:
- Whether the authRole field is set.
-
getAuthRole
@Deprecated Common.AuthRole getAuthRole()
Deprecated.flyteidl.admin.ExecutionSpec.auth_role is deprecated. See flyteidl/admin/execution.proto;l=276Optional: auth override to apply this execution.
.flyteidl.admin.AuthRole auth_role = 16 [deprecated = true];- Returns:
- The authRole.
-
getAuthRoleOrBuilder
@Deprecated Common.AuthRoleOrBuilder getAuthRoleOrBuilder()
Deprecated.Optional: auth override to apply this execution.
.flyteidl.admin.AuthRole auth_role = 16 [deprecated = true];
-
hasQualityOfService
boolean hasQualityOfService()
Indicates the runtime priority of the execution.
.flyteidl.core.QualityOfService quality_of_service = 17;- Returns:
- Whether the qualityOfService field is set.
-
getQualityOfService
Execution.QualityOfService getQualityOfService()
Indicates the runtime priority of the execution.
.flyteidl.core.QualityOfService quality_of_service = 17;- Returns:
- The qualityOfService.
-
getQualityOfServiceOrBuilder
Execution.QualityOfServiceOrBuilder getQualityOfServiceOrBuilder()
Indicates the runtime priority of the execution.
.flyteidl.core.QualityOfService quality_of_service = 17;
-
getMaxParallelism
int getMaxParallelism()
Controls the maximum number of task nodes that can be run in parallel for the entire workflow. This is useful to achieve fairness. Note: MapTasks are regarded as one unit, and parallelism/concurrency of MapTasks is independent from this.
int32 max_parallelism = 18;- Returns:
- The maxParallelism.
-
hasRawOutputDataConfig
boolean hasRawOutputDataConfig()
User setting to configure where to store offloaded data (i.e. Blobs, structured datasets, query data, etc.). This should be a prefix like s3://my-bucket/my-data
.flyteidl.admin.RawOutputDataConfig raw_output_data_config = 19;- Returns:
- Whether the rawOutputDataConfig field is set.
-
getRawOutputDataConfig
Common.RawOutputDataConfig getRawOutputDataConfig()
User setting to configure where to store offloaded data (i.e. Blobs, structured datasets, query data, etc.). This should be a prefix like s3://my-bucket/my-data
.flyteidl.admin.RawOutputDataConfig raw_output_data_config = 19;- Returns:
- The rawOutputDataConfig.
-
getRawOutputDataConfigOrBuilder
Common.RawOutputDataConfigOrBuilder getRawOutputDataConfigOrBuilder()
User setting to configure where to store offloaded data (i.e. Blobs, structured datasets, query data, etc.). This should be a prefix like s3://my-bucket/my-data
.flyteidl.admin.RawOutputDataConfig raw_output_data_config = 19;
-
hasClusterAssignment
boolean hasClusterAssignment()
Controls how to select an available cluster on which this execution should run.
.flyteidl.admin.ClusterAssignment cluster_assignment = 20;- Returns:
- Whether the clusterAssignment field is set.
-
getClusterAssignment
ClusterAssignmentOuterClass.ClusterAssignment getClusterAssignment()
Controls how to select an available cluster on which this execution should run.
.flyteidl.admin.ClusterAssignment cluster_assignment = 20;- Returns:
- The clusterAssignment.
-
getClusterAssignmentOrBuilder
ClusterAssignmentOuterClass.ClusterAssignmentOrBuilder getClusterAssignmentOrBuilder()
Controls how to select an available cluster on which this execution should run.
.flyteidl.admin.ClusterAssignment cluster_assignment = 20;
-
hasInterruptible
boolean hasInterruptible()
Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field.
.google.protobuf.BoolValue interruptible = 21;- Returns:
- Whether the interruptible field is set.
-
getInterruptible
com.google.protobuf.BoolValue getInterruptible()
Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field.
.google.protobuf.BoolValue interruptible = 21;- Returns:
- The interruptible.
-
getInterruptibleOrBuilder
com.google.protobuf.BoolValueOrBuilder getInterruptibleOrBuilder()
Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field.
.google.protobuf.BoolValue interruptible = 21;
-
getNotificationOverridesCase
ExecutionOuterClass.ExecutionSpec.NotificationOverridesCase getNotificationOverridesCase()
-
-