Package flyteidl.admin

Interface LaunchPlanOuterClass.LaunchPlanSpecOrBuilder

    • Method Detail

      • hasWorkflowId

        boolean hasWorkflowId()
         Reference to the Workflow template that the launch plan references
        .flyteidl.core.Identifier workflow_id = 1;
        Returns:
        Whether the workflowId field is set.

      • getWorkflowId

        IdentifierOuterClass.Identifier getWorkflowId()
         Reference to the Workflow template that the launch plan references
        .flyteidl.core.Identifier workflow_id = 1;
        Returns:
        The workflowId.

      • getWorkflowIdOrBuilder

        IdentifierOuterClass.IdentifierOrBuilder getWorkflowIdOrBuilder()
         Reference to the Workflow template that the launch plan references
        .flyteidl.core.Identifier workflow_id = 1;

      • hasEntityMetadata

        boolean hasEntityMetadata()
         Metadata for the Launch Plan
        .flyteidl.admin.LaunchPlanMetadata entity_metadata = 2;
        Returns:
        Whether the entityMetadata field is set.

      • hasDefaultInputs

        boolean hasDefaultInputs()
         Input values to be passed for the execution.
 These can be overriden when an execution is created with this launch plan.
        .flyteidl.core.ParameterMap default_inputs = 3;
        Returns:
        Whether the defaultInputs field is set.

      • getDefaultInputs

        Interface.ParameterMap getDefaultInputs()
         Input values to be passed for the execution.
 These can be overriden when an execution is created with this launch plan.
        .flyteidl.core.ParameterMap default_inputs = 3;
        Returns:
        The defaultInputs.

      • getDefaultInputsOrBuilder

        Interface.ParameterMapOrBuilder getDefaultInputsOrBuilder()
         Input values to be passed for the execution.
 These can be overriden when an execution is created with this launch plan.
        .flyteidl.core.ParameterMap default_inputs = 3;

      • hasFixedInputs

        boolean hasFixedInputs()
         Fixed, non-overridable inputs for the Launch Plan.
 These can not be overriden when an execution is created with this launch plan.
        .flyteidl.core.LiteralMap fixed_inputs = 4;
        Returns:
        Whether the fixedInputs field is set.

      • getFixedInputs

        Literals.LiteralMap getFixedInputs()
         Fixed, non-overridable inputs for the Launch Plan.
 These can not be overriden when an execution is created with this launch plan.
        .flyteidl.core.LiteralMap fixed_inputs = 4;
        Returns:
        The fixedInputs.

      • getFixedInputsOrBuilder

        Literals.LiteralMapOrBuilder getFixedInputsOrBuilder()
         Fixed, non-overridable inputs for the Launch Plan.
 These can not be overriden when an execution is created with this launch plan.
        .flyteidl.core.LiteralMap fixed_inputs = 4;

      • getRole

        @Deprecated
String getRole()
        Deprecated.
        flyteidl.admin.LaunchPlanSpec.role is deprecated. See flyteidl/admin/launch_plan.proto;l=95
         String to indicate the role to use to execute the workflow underneath
        string role = 5 [deprecated = true];
        Returns:
        The role.

      • getRoleBytes

        @Deprecated
com.google.protobuf.ByteString getRoleBytes()
        Deprecated.
        flyteidl.admin.LaunchPlanSpec.role is deprecated. See flyteidl/admin/launch_plan.proto;l=95
         String to indicate the role to use to execute the workflow underneath
        string role = 5 [deprecated = true];
        Returns:
        The bytes for role.

      • hasLabels

        boolean hasLabels()
         Custom labels to be applied to the execution resource.
        .flyteidl.admin.Labels labels = 6;
        Returns:
        Whether the labels field is set.

      • getLabels

        Common.Labels getLabels()
         Custom labels to be applied to the execution resource.
        .flyteidl.admin.Labels labels = 6;
        Returns:
        The labels.

      • getLabelsOrBuilder

        Common.LabelsOrBuilder getLabelsOrBuilder()
         Custom labels to be applied to the execution resource.
        .flyteidl.admin.Labels labels = 6;

      • hasAnnotations

        boolean hasAnnotations()
         Custom annotations to be applied to the execution resource.
        .flyteidl.admin.Annotations annotations = 7;
        Returns:
        Whether the annotations field is set.

      • getAnnotations

        Common.Annotations getAnnotations()
         Custom annotations to be applied to the execution resource.
        .flyteidl.admin.Annotations annotations = 7;
        Returns:
        The annotations.

      • getAnnotationsOrBuilder

        Common.AnnotationsOrBuilder getAnnotationsOrBuilder()
         Custom annotations to be applied to the execution resource.
        .flyteidl.admin.Annotations annotations = 7;

      • hasAuth

        @Deprecated
boolean hasAuth()
        Deprecated.
        flyteidl.admin.LaunchPlanSpec.auth is deprecated. See flyteidl/admin/launch_plan.proto;l=104
         Indicates the permission associated with workflow executions triggered with this launch plan.
        .flyteidl.admin.Auth auth = 8 [deprecated = true];
        Returns:
        Whether the auth field is set.

      • getAuth

        @Deprecated
LaunchPlanOuterClass.Auth getAuth()
        Deprecated.
        flyteidl.admin.LaunchPlanSpec.auth is deprecated. See flyteidl/admin/launch_plan.proto;l=104
         Indicates the permission associated with workflow executions triggered with this launch plan.
        .flyteidl.admin.Auth auth = 8 [deprecated = true];
        Returns:
        The auth.

      • getAuthOrBuilder

        @Deprecated
LaunchPlanOuterClass.AuthOrBuilder getAuthOrBuilder()
        Deprecated.
         Indicates the permission associated with workflow executions triggered with this launch plan.
        .flyteidl.admin.Auth auth = 8 [deprecated = true];

      • hasAuthRole

        @Deprecated
boolean hasAuthRole()
        Deprecated.
        flyteidl.admin.LaunchPlanSpec.auth_role is deprecated. See flyteidl/admin/launch_plan.proto;l=106
        .flyteidl.admin.AuthRole auth_role = 9 [deprecated = true];
        Returns:
        Whether the authRole field is set.

      • getAuthRole

        @Deprecated
Common.AuthRole getAuthRole()
        Deprecated.
        flyteidl.admin.LaunchPlanSpec.auth_role is deprecated. See flyteidl/admin/launch_plan.proto;l=106
        .flyteidl.admin.AuthRole auth_role = 9 [deprecated = true];
        Returns:
        The authRole.

      • hasSecurityContext

        boolean hasSecurityContext()
         Indicates security context for permissions triggered with this launch plan
        .flyteidl.core.SecurityContext security_context = 10;
        Returns:
        Whether the securityContext field is set.

      • getSecurityContext

        Security.SecurityContext getSecurityContext()
         Indicates security context for permissions triggered with this launch plan
        .flyteidl.core.SecurityContext security_context = 10;
        Returns:
        The securityContext.

      • getSecurityContextOrBuilder

        Security.SecurityContextOrBuilder getSecurityContextOrBuilder()
         Indicates security context for permissions triggered with this launch plan
        .flyteidl.core.SecurityContext security_context = 10;

      • hasQualityOfService

        boolean hasQualityOfService()
         Indicates the runtime priority of the execution.
        .flyteidl.core.QualityOfService quality_of_service = 16;
        Returns:
        Whether the qualityOfService field is set.

      • getQualityOfService

        Execution.QualityOfService getQualityOfService()
         Indicates the runtime priority of the execution.
        .flyteidl.core.QualityOfService quality_of_service = 16;
        Returns:
        The qualityOfService.

      • getQualityOfServiceOrBuilder

        Execution.QualityOfServiceOrBuilder getQualityOfServiceOrBuilder()
         Indicates the runtime priority of the execution.
        .flyteidl.core.QualityOfService quality_of_service = 16;

      • hasRawOutputDataConfig

        boolean hasRawOutputDataConfig()
         Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
        .flyteidl.admin.RawOutputDataConfig raw_output_data_config = 17;
        Returns:
        Whether the rawOutputDataConfig field is set.

      • getRawOutputDataConfig

        Common.RawOutputDataConfig getRawOutputDataConfig()
         Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
        .flyteidl.admin.RawOutputDataConfig raw_output_data_config = 17;
        Returns:
        The rawOutputDataConfig.

      • getRawOutputDataConfigOrBuilder

        Common.RawOutputDataConfigOrBuilder getRawOutputDataConfigOrBuilder()
         Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
        .flyteidl.admin.RawOutputDataConfig raw_output_data_config = 17;

      • getMaxParallelism

        int getMaxParallelism()
         Controls the maximum number of tasknodes 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.

      • 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 = 19;
        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 = 19;
        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 = 19;