Share via


JobInformation Constructors

Definition

Overloads

JobInformation()

Initializes a new instance of the JobInformation class.

JobInformation(String, JobType, JobProperties, Nullable<Guid>, String, IList<JobErrorDetails>, Nullable<Int32>, Nullable<Int32>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<JobState>, Nullable<JobResult>, String, IList<String>, IList<JobStateAuditRecord>, JobRelationshipProperties)

Initializes a new instance of the JobInformation class.

JobInformation(String, JobType, JobProperties, Nullable<Guid>, String, Nullable<Int32>, Nullable<Double>, Nullable<Int32>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<JobState>, Nullable<JobResult>, String, IList<String>, JobRelationshipProperties, IDictionary<String,String>, String, IList<JobErrorDetails>, IList<JobStateAuditRecord>)

Initializes a new instance of the JobInformation class.

JobInformation()

Initializes a new instance of the JobInformation class.

public JobInformation ();
Public Sub New ()

Applies to

JobInformation(String, JobType, JobProperties, Nullable<Guid>, String, IList<JobErrorDetails>, Nullable<Int32>, Nullable<Int32>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<JobState>, Nullable<JobResult>, String, IList<String>, IList<JobStateAuditRecord>, JobRelationshipProperties)

Initializes a new instance of the JobInformation class.

public JobInformation (string name, Microsoft.Azure.Management.DataLake.Analytics.Models.JobType type, Microsoft.Azure.Management.DataLake.Analytics.Models.JobProperties properties, Guid? jobId = default, string submitter = default, System.Collections.Generic.IList<Microsoft.Azure.Management.DataLake.Analytics.Models.JobErrorDetails> errorMessage = default, int? degreeOfParallelism = default, int? priority = default, DateTimeOffset? submitTime = default, DateTimeOffset? startTime = default, DateTimeOffset? endTime = default, Microsoft.Azure.Management.DataLake.Analytics.Models.JobState? state = default, Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult? result = default, string logFolder = default, System.Collections.Generic.IList<string> logFilePatterns = default, System.Collections.Generic.IList<Microsoft.Azure.Management.DataLake.Analytics.Models.JobStateAuditRecord> stateAuditRecords = default, Microsoft.Azure.Management.DataLake.Analytics.Models.JobRelationshipProperties related = default);
new Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation : string * Microsoft.Azure.Management.DataLake.Analytics.Models.JobType * Microsoft.Azure.Management.DataLake.Analytics.Models.JobProperties * Nullable<Guid> * string * System.Collections.Generic.IList<Microsoft.Azure.Management.DataLake.Analytics.Models.JobErrorDetails> * Nullable<int> * Nullable<int> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<Microsoft.Azure.Management.DataLake.Analytics.Models.JobState> * Nullable<Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult> * string * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<Microsoft.Azure.Management.DataLake.Analytics.Models.JobStateAuditRecord> * Microsoft.Azure.Management.DataLake.Analytics.Models.JobRelationshipProperties -> Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation
Public Sub New (name As String, type As JobType, properties As JobProperties, Optional jobId As Nullable(Of Guid) = Nothing, Optional submitter As String = Nothing, Optional errorMessage As IList(Of JobErrorDetails) = Nothing, Optional degreeOfParallelism As Nullable(Of Integer) = Nothing, Optional priority As Nullable(Of Integer) = Nothing, Optional submitTime As Nullable(Of DateTimeOffset) = Nothing, Optional startTime As Nullable(Of DateTimeOffset) = Nothing, Optional endTime As Nullable(Of DateTimeOffset) = Nothing, Optional state As Nullable(Of JobState) = Nothing, Optional result As Nullable(Of JobResult) = Nothing, Optional logFolder As String = Nothing, Optional logFilePatterns As IList(Of String) = Nothing, Optional stateAuditRecords As IList(Of JobStateAuditRecord) = Nothing, Optional related As JobRelationshipProperties = Nothing)

Parameters

name
String

the friendly name of the job.

type
JobType

the job type of the current job (Hive or USql). Possible values include: 'USql', 'Hive'

properties
JobProperties

the job specific properties.

jobId
Nullable<Guid>

the job's unique identifier (a GUID).

submitter
String

the user or account that submitted the job.

errorMessage
IList<JobErrorDetails>

the error message details for the job, if the job failed.

degreeOfParallelism
Nullable<Int32>

the degree of parallelism used for this job. This must be greater than 0, if set to less than 0 it will default to 1.

priority
Nullable<Int32>

the priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0.

submitTime
Nullable<DateTimeOffset>

the time the job was submitted to the service.

startTime
Nullable<DateTimeOffset>

the start time of the job.

endTime
Nullable<DateTimeOffset>

the completion time of the job.

state
Nullable<JobState>

the job state. When the job is in the Ended state, refer to Result and ErrorMessage for details. Possible values include: 'Accepted', 'Compiling', 'Ended', 'New', 'Queued', 'Running', 'Scheduling', 'Starting', 'Paused', 'WaitingForCapacity'

result
Nullable<JobResult>

the result of job execution or the current result of the running job. Possible values include: 'None', 'Succeeded', 'Cancelled', 'Failed'

logFolder
String

the log folder path to use in the following format: adl://<accountName>.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/.

logFilePatterns
IList<String>

the list of log file name patterns to find in the logFolder. '' is the only matching character allowed. Example format: jobExecution.log or mylog.txt

stateAuditRecords
IList<JobStateAuditRecord>

the job state audit records, indicating when various operations have been performed on this job.

related
JobRelationshipProperties

the recurring job relationship information properties.

Applies to

JobInformation(String, JobType, JobProperties, Nullable<Guid>, String, Nullable<Int32>, Nullable<Double>, Nullable<Int32>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<JobState>, Nullable<JobResult>, String, IList<String>, JobRelationshipProperties, IDictionary<String,String>, String, IList<JobErrorDetails>, IList<JobStateAuditRecord>)

Initializes a new instance of the JobInformation class.

public JobInformation (string name, Microsoft.Azure.Management.DataLake.Analytics.Models.JobType type, Microsoft.Azure.Management.DataLake.Analytics.Models.JobProperties properties, Guid? jobId = default, string submitter = default, int? degreeOfParallelism = default, double? degreeOfParallelismPercent = default, int? priority = default, DateTimeOffset? submitTime = default, DateTimeOffset? startTime = default, DateTimeOffset? endTime = default, Microsoft.Azure.Management.DataLake.Analytics.Models.JobState? state = default, Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult? result = default, string logFolder = default, System.Collections.Generic.IList<string> logFilePatterns = default, Microsoft.Azure.Management.DataLake.Analytics.Models.JobRelationshipProperties related = default, System.Collections.Generic.IDictionary<string,string> tags = default, string hierarchyQueueNode = default, System.Collections.Generic.IList<Microsoft.Azure.Management.DataLake.Analytics.Models.JobErrorDetails> errorMessage = default, System.Collections.Generic.IList<Microsoft.Azure.Management.DataLake.Analytics.Models.JobStateAuditRecord> stateAuditRecords = default);
new Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation : string * Microsoft.Azure.Management.DataLake.Analytics.Models.JobType * Microsoft.Azure.Management.DataLake.Analytics.Models.JobProperties * Nullable<Guid> * string * Nullable<int> * Nullable<double> * Nullable<int> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<Microsoft.Azure.Management.DataLake.Analytics.Models.JobState> * Nullable<Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult> * string * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.DataLake.Analytics.Models.JobRelationshipProperties * System.Collections.Generic.IDictionary<string, string> * string * System.Collections.Generic.IList<Microsoft.Azure.Management.DataLake.Analytics.Models.JobErrorDetails> * System.Collections.Generic.IList<Microsoft.Azure.Management.DataLake.Analytics.Models.JobStateAuditRecord> -> Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation
Public Sub New (name As String, type As JobType, properties As JobProperties, Optional jobId As Nullable(Of Guid) = Nothing, Optional submitter As String = Nothing, Optional degreeOfParallelism As Nullable(Of Integer) = Nothing, Optional degreeOfParallelismPercent As Nullable(Of Double) = Nothing, Optional priority As Nullable(Of Integer) = Nothing, Optional submitTime As Nullable(Of DateTimeOffset) = Nothing, Optional startTime As Nullable(Of DateTimeOffset) = Nothing, Optional endTime As Nullable(Of DateTimeOffset) = Nothing, Optional state As Nullable(Of JobState) = Nothing, Optional result As Nullable(Of JobResult) = Nothing, Optional logFolder As String = Nothing, Optional logFilePatterns As IList(Of String) = Nothing, Optional related As JobRelationshipProperties = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional hierarchyQueueNode As String = Nothing, Optional errorMessage As IList(Of JobErrorDetails) = Nothing, Optional stateAuditRecords As IList(Of JobStateAuditRecord) = Nothing)

Parameters

name
String

The friendly name of the job.

type
JobType

The job type of the current job (Hive, USql, or Scope (for internal use only)). Possible values include: 'USql', 'Hive', 'Scope'

properties
JobProperties

The job specific properties.

jobId
Nullable<Guid>

The job's unique identifier (a GUID).

submitter
String

The user or account that submitted the job.

degreeOfParallelism
Nullable<Int32>

The degree of parallelism used for this job.

degreeOfParallelismPercent
Nullable<Double>

the degree of parallelism in percentage used for this job.

priority
Nullable<Int32>

The priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0.

submitTime
Nullable<DateTimeOffset>

The time the job was submitted to the service.

startTime
Nullable<DateTimeOffset>

The start time of the job.

endTime
Nullable<DateTimeOffset>

The completion time of the job.

state
Nullable<JobState>

The job state. When the job is in the Ended state, refer to Result and ErrorMessage for details. Possible values include: 'Accepted', 'Compiling', 'Ended', 'New', 'Queued', 'Running', 'Scheduling', 'Starting', 'Paused', 'WaitingForCapacity', 'Yielded', 'Finalizing'

result
Nullable<JobResult>

The result of job execution or the current result of the running job. Possible values include: 'None', 'Succeeded', 'Cancelled', 'Failed'

logFolder
String

The log folder path to use in the following format: adl://<accountName>.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/.

logFilePatterns
IList<String>

The list of log file name patterns to find in the logFolder. '' is the only matching character allowed. Example format: jobExecution.log or mylog.txt

related
JobRelationshipProperties

The recurring job relationship information properties.

tags
IDictionary<String,String>

The key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)

hierarchyQueueNode
String

the name of hierarchy queue node this job is assigned to, Null if job has not been assigned yet or the account doesn't have hierarchy queue.

errorMessage
IList<JobErrorDetails>

The error message details for the job, if the job failed.

stateAuditRecords
IList<JobStateAuditRecord>

The job state audit records, indicating when various operations have been performed on this job.

Applies to