Share via


SparkJob Class

Definition

Spark job definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.SparkJobTypeConverter))]
public class SparkJob : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ISparkJob, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.SparkJobTypeConverter))>]
type SparkJob = class
    interface ISparkJob
    interface IJsonSerializable
    interface IJobBaseProperties
    interface IResourceBase
    interface IValidates
Public Class SparkJob
Implements ISparkJob, IValidates
Inheritance
SparkJob
Attributes
Implements

Constructors

SparkJob()

Creates an new SparkJob instance.

Properties

Archive

Archive files used in the job.

Arg

Arguments for the job.

CodeId

[Required] arm-id of the code asset.

ComponentId

ARM resource ID of the component resource.

ComputeId

ARM resource ID of the compute resource.

Conf

Spark configured properties.

Description

The asset description text.

DisplayName

Display name of job.

EntrySparkJobEntryType

[Required] Type of the job's entry point.

EnvironmentId

The ARM resource ID of the Environment specification for the job.

EnvironmentVariable

Environment variables included in the job.

ExperimentName

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

File

Files used in the job.

Identity

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.

IdentityType

[Required] Specifies the type of identity framework.

Input

Mapping of input data bindings used in the job.

IsArchived

Is the asset archived?

Jar

Jar files used in the job.

JobType

[Required] Specifies the type of job.

NotificationSetting

Notification setting for the job

NotificationSettingEmail

This is the email recipient list which has a limitation of 499 characters in total concat with comma separator

NotificationSettingEmailOn

Send email notification to user on specified notification type

NotificationSettingWebhook

Send webhook callback to a service. Key is a user-provided name for the webhook.

Output

Mapping of output data bindings used in the job.

Property

The asset property dictionary.

PyFile

Python files used in the job.

QueueSettingJobTier

Controls the compute job tier

ResourceInstanceType

Optional type of VM used as supported by the compute target.

ResourceRuntimeVersion

Version of spark runtime used for the job.

Service

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

Status

Status of the job.

Tag

Tag dictionary. Tags can be added, removed, and updated.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of SparkJob.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of SparkJob.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ISparkJob.

FromJsonString(String)

Creates a new instance of SparkJob, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of SparkJob into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to