public class Job extends Object implements Serializable
Constructor and Description |
---|
Job()
Constructor.
|
Job(String path)
Constructor.
|
Job(String path,
String version)
Constructor.
|
Job(String path,
String version,
SourceLocation sourceLocation)
Constructor.
|
Job(String path,
String version,
String owner,
boolean runAsOwner)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addCharacterMaskedParameter(String name,
String label,
String value)
Adds a
JobParameter with the specified information that is masked. |
void |
addCharacterParameter(String name,
String label,
String value)
Adds a
JobParameter with the specified information. |
void |
addDateParameter(String name,
String label,
Date value)
Adds a
JobParameter with the specified information. |
void |
addFileParameter(String name,
String label,
String path)
Adds a
JobParameter with the specified JobInputFile information. |
void |
addFileParameter(String name,
String label,
String path,
String version)
Adds a
JobParameter with the specified JobInputFile information. |
void |
addFolderParameter(String name,
String label,
String path)
Adds a
JobParameter with the specified JobInputFolder information. |
void |
addFolderParameter(String name,
String label,
String path,
boolean includeSubfolders)
Adds a
JobParameter with the specified JobInputFolder information. |
void |
addNumericParameter(String name,
String label,
String value)
Adds a
JobParameter with the specified information that represents a numeric value. |
void |
addProgram(String path)
Adds a
JobProgram with the specified path. |
void |
addProgram(String path,
String version)
Adds a
JobProgram with the specified information. |
boolean |
equals(Object obj) |
String |
getDescription()
Gets the description of the job.
|
String |
getLogsLocation()
Gets the location for job submission log files to be saved.
|
String |
getManifestLocation()
Gets the location for the job submission manifest file to be saved.
|
String |
getOwner()
Gets the userId of the current owner of the job.
|
List<JobParameter> |
getParameters()
Gets the job parameters.
|
String |
getPath()
Gets the path of the job.
|
List<JobProgram> |
getPrograms()
Gets the programs that are associated with the job.
|
JobPublishCheckin |
getPublishCheckin()
Gets the check-in specification to use for the output files that are created by the job.
|
JobPublishSetup |
getPublishSetup()
Gets the content to transfer when submitting the job.
|
String |
getResultsLocation()
Gets the location for the job execution results files to be saved.
|
SourceLocation |
getSourceLocation()
Gets the source location of the job.
|
String |
getVersion()
Gets the version of the job.
|
int |
hashCode() |
boolean |
isRunAsOwner()
Indicates whether the job runs as the owner of the file or as the user who submitted the file for execution.
|
void |
setDescription(String description)
Sets the description of the job.
|
void |
setLogsLocation(String logsLocation)
Sets the location for the job submission log files to be saved.
|
void |
setManifestLocation(String manifestLocation)
Sets the location for the job submission manifest file to be saved.
|
void |
setParameters(List<JobParameter> parameters)
Sets the job parameters.
|
void |
setPath(String path)
Sets the path of the job.
|
void |
setPrograms(List<JobProgram> programs)
Sets the programs to associate with the job.
|
void |
setPublishCheckin(JobPublishCheckin publishCheckin)
Sets the check-in specification to use for the output files that are created by the job.
|
void |
setPublishSetup(JobPublishSetup publishSetup)
Sets the content to transfer when submitting the job.
|
void |
setResultsLocation(String resultsLocation)
Sets the location for the job submission results files to be saved.
|
void |
setSourceLocation(SourceLocation sourceLocation)
Sets the source location of the job.
|
String |
toString() |
public Job()
public Job(String path)
path
- The path to the job.public Job(String path, String version)
path
- The path to the job.version
- The version label for the job.public Job(String path, String version, SourceLocation sourceLocation)
path
- The path to the job.version
- The version label for the job.sourceLocation
- The source location of the job.public String getPath()
public void setPath(String path)
path
- The path of the job.public String getVersion()
public SourceLocation getSourceLocation()
public void setSourceLocation(SourceLocation sourceLocation)
sourceLocation
- The source location of the job.public String getDescription()
public void setDescription(String description)
description
- The description of the job.public List<JobProgram> getPrograms()
public void setPrograms(List<JobProgram> programs)
programs
- The programs to associate.public JobPublishSetup getPublishSetup()
public void setPublishSetup(JobPublishSetup publishSetup)
publishSetup
- The content to transfer when submitting the job.public JobPublishCheckin getPublishCheckin()
public void setPublishCheckin(JobPublishCheckin publishCheckin)
publishCheckin
- The check-in specification for the output files.public String getLogsLocation()
public void setLogsLocation(String logsLocation)
logsLocation
- The location for the job submission log files to be saved.public String getResultsLocation()
public void setResultsLocation(String resultsLocation)
resultsLocation
- The location for the job submission results files to be saved.public String getManifestLocation()
public void setManifestLocation(String manifestLocation)
manifestLocation
- The location for the job submission manifest file to be saved.public List<JobParameter> getParameters()
JobInput
. The values of CHARACTER and NUMERIC parameters are a String, and a
DATE parameter value is a java.util.Date.public void setParameters(List<JobParameter> parameters)
JobInput
. The values of CHARACTER and NUMERIC parameters must be specified as
a String, and a DATE parameter value must be specified as a java.util.Date.
parameters
- The job parameters.public String getOwner()
public boolean isRunAsOwner()
public void addProgram(String path)
JobProgram
with the specified path. The default version is null which specifies that the latest
version is used when submitted as a published job.path
- The path to the program.public void addProgram(String path, String version)
JobProgram
with the specified information. Specifying null for the version specifies that the
latest version is used when the program is submitted with a published job.path
- The path to the program.version
- The version of the program. If null, the latest version is is used when the program is submitted
with a published job.public void addFileParameter(String name, String label, String path)
JobParameter
with the specified JobInputFile
information. By default, the version
specified is null, which specifies that the latest version will be used when the program is submitted with a
published job. name
- The name of the job parameter.label
- The label of the job parameter.path
- The default path for the parameter. The default version is the latest (null).public void addFileParameter(String name, String label, String path, String version)
JobParameter
with the specified JobInputFile
information. Specifying null for the version
specifies that the latest version will be used when the program is submitted with a published job. name
- The name of the job parameter.label
- The label of the job parameter.path
- The default path for the parameter.version
- The version to be set on the JobInputFile
as the default value for the parameter.
Specifying null means the latest version will be used when submitted as a published job.public void addFolderParameter(String name, String label, String path)
JobParameter
with the specified JobInputFolder
information. By default, the folder does
not include subfolders when transferred for a published job run. Only the files that are directly underneath it
are transferred.
name
- The name of the job parameter.label
- The label of the job parameter.path
- The default path for the parameter.public void addFolderParameter(String name, String label, String path, boolean includeSubfolders)
JobParameter
with the specified JobInputFolder
information. By default, the folder does
not include subfolders when transferred for a published job run. Only the files that are directly underneath it
will be transferred. Sets includeSubfolders
to true to transfer the folder and all of the files and
folders underneath it. name
- The name of the job parameter.label
- The label of the job parameter.path
- The default path for the parameter.includeSubfolders
- Indicates whether to transfer all files and folders that are underneath the specified
folder.public void addCharacterParameter(String name, String label, String value)
JobParameter
with the specified information.name
- The name of the job parameter.label
- The label of the job parameter.value
- The default value of the job parameter.public void addCharacterMaskedParameter(String name, String label, String value)
JobParameter
with the specified information that is masked.name
- The name of the job parameter.label
- The label of the job parameter.value
- The masked default value of the job parameter.public void addNumericParameter(String name, String label, String value)
JobParameter
with the specified information that represents a numeric value.name
- The name of the job parameter.label
- The label of the job parameter.value
- The default value of the job parameter that represents a numeric value.public void addDateParameter(String name, String label, Date value)
JobParameter
with the specified information.name
- The name of the job parameter.label
- The label of the job parameter.value
- The default value of the job parameter.<i>Copyright (c) 2020, SAS Institute Inc., Cary, NC, USA</i>