com.microsoft.azure.management.datalake.analytics.models

Class JobInformationBasic

java.lang.Object

com.microsoft.azure.management.datalake.analytics.models.JobInformationBasic

Direct Known Subclasses:

JobInformation

public class JobInformationBasic
extends Object

The common Data Lake Analytics job information properties.

Constructor Summary

Constructors

Constructor and Description
JobInformationBasic()

Method Summary

Modifier and Type	Method and Description
Integer	degreeOfParallelism() Get the degree of parallelism used for this job.
org.joda.time.DateTime	endTime() Get the completion time of the job.
UUID	jobId() Get the job's unique identifier (a GUID).
List<String>	logFilePatterns() Get the list of log file name patterns to find in the logFolder.
String	logFolder() Get 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/.
String	name() Get the friendly name of the job.
Integer	priority() Get the priority value for the current job.
JobRelationshipProperties	related() Get the recurring job relationship information properties.
JobResult	result() Get the result of job execution or the current result of the running job.
org.joda.time.DateTime	startTime() Get the start time of the job.
JobState	state() Get the job state.
String	submitter() Get the user or account that submitted the job.
org.joda.time.DateTime	submitTime() Get the time the job was submitted to the service.
Map<String,String>	tags() Get the key-value pairs used to add additional metadata to the job information.
JobType	type() Get the job type of the current job (Hive, USql, or Scope (for internal use only)).
JobInformationBasic	withDegreeOfParallelism(Integer degreeOfParallelism) Set the degree of parallelism used for this job.
JobInformationBasic	withLogFilePatterns(List<String> logFilePatterns) Set the list of log file name patterns to find in the logFolder.
JobInformationBasic	withName(String name) Set the friendly name of the job.
JobInformationBasic	withPriority(Integer priority) Set the priority value for the current job.
JobInformationBasic	withRelated(JobRelationshipProperties related) Set the recurring job relationship information properties.
JobInformationBasic	withTags(Map<String,String> tags) Set the key-value pairs used to add additional metadata to the job information.
JobInformationBasic	withType(JobType type) Set the job type of the current job (Hive, USql, or Scope (for internal use only)).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobInformationBasic

public JobInformationBasic()

Method Detail

jobId

public UUID jobId()

Get the job's unique identifier (a GUID).

Returns:

the jobId value

name

public String name()

Get the friendly name of the job.

Returns:

the name value

withName

public JobInformationBasic withName(String name)

Set the friendly name of the job.

Parameters:

name - the name value to set

Returns:

the JobInformationBasic object itself.

type

public JobType type()

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

Returns:

the type value

withType

public JobInformationBasic withType(JobType type)

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

Parameters:

type - the type value to set

Returns:

the JobInformationBasic object itself.

submitter

public String submitter()

Get the user or account that submitted the job.

Returns:

the submitter value

degreeOfParallelism

public Integer degreeOfParallelism()

Get 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.

Returns:

the degreeOfParallelism value

withDegreeOfParallelism

public JobInformationBasic withDegreeOfParallelism(Integer degreeOfParallelism)

Set 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.

Parameters:

degreeOfParallelism - the degreeOfParallelism value to set

Returns:

the JobInformationBasic object itself.

priority

public Integer priority()

Get 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.

Returns:

the priority value

withPriority

public JobInformationBasic withPriority(Integer priority)

Set 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.

Parameters:

priority - the priority value to set

Returns:

the JobInformationBasic object itself.

submitTime

public org.joda.time.DateTime submitTime()

Get the time the job was submitted to the service.

Returns:

the submitTime value

startTime

public org.joda.time.DateTime startTime()

Get the start time of the job.

Returns:

the startTime value

endTime

public org.joda.time.DateTime endTime()

Get the completion time of the job.

Returns:

the endTime value

state

public JobState state()

Get 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'.

Returns:

the state value

result

public JobResult result()

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

Returns:

the result value

logFolder

public String logFolder()

Get 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/.

Returns:

the logFolder value

logFilePatterns

public List<String> logFilePatterns()

Get 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.

Returns:

the logFilePatterns value

withLogFilePatterns

public JobInformationBasic withLogFilePatterns(List<String> logFilePatterns)

Set 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.

Parameters:

logFilePatterns - the logFilePatterns value to set

Returns:

the JobInformationBasic object itself.

related

public JobRelationshipProperties related()

Get the recurring job relationship information properties.

Returns:

the related value

withRelated

public JobInformationBasic withRelated(JobRelationshipProperties related)

Set the recurring job relationship information properties.

Parameters:

related - the related value to set

Returns:

the JobInformationBasic object itself.

tags

public Map<String,String> tags()

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

Returns:

the tags value

withTags

public JobInformationBasic withTags(Map<String,String> tags)

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

Parameters:

tags - the tags value to set

Returns:

the JobInformationBasic object itself.