Class Job

java.lang.Object
org.javastro.ivoa.entities.uws.Job
All Implemented Interfaces:
org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public class Job extends Object implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
The complete representation of the state of a job

Java class for JobSummary complex type

.

The following schema fragment specifies the expected content contained within this class.


 <complexType name="JobSummary">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="jobId" type="{http://www.ivoa.net/xml/UWS/v1.0}JobIdentifier"/>
         <element name="runId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ownerId" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="phase" type="{http://www.ivoa.net/xml/UWS/v1.0}ExecutionPhase"/>
         <element name="quote" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="creationTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="startTime" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
         <element name="endTime" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
         <element name="executionDuration" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="destruction" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
         <element ref="{http://www.ivoa.net/xml/UWS/v1.0}parameters" minOccurs="0"/>
         <element ref="{http://www.ivoa.net/xml/UWS/v1.0}results"/>
         <element name="errorSummary" type="{http://www.ivoa.net/xml/UWS/v1.0}ErrorSummary" minOccurs="0"/>
         <element name="jobInfo" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <any processContents='lax' maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </sequence>
       <attribute name="version" type="{http://www.ivoa.net/xml/UWS/v1.0}UWSVersion" />
     </restriction>
   </complexContent>
 </complexType>
 
  • Field Details

    • jobId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected String jobId
    • runId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected String runId
      this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job
    • ownerId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected String ownerId
      the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards. If there was no authenticated job creator then this should be set to NULL.
    • phase

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected ExecutionPhase phase
      the execution phase - returned at /{jobs}/{job-id}/phase
    • quote

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected LocalDateTime quote
      A Quote predicts when the job is likely to complete - returned at /{jobs}/{job-id}/quote "don't know" is encoded by setting to the XML null value xsi:nil="true"
    • creationTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected LocalDateTime creationTime
      Note that the version 1.1 of the specification requires that this element be present. It is optional only in versions 1.x of the schema for backwards compatibility. 2.0+ versions of the schema will make this formally mandatory in an XML sense.
    • startTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected LocalDateTime startTime
      The instant at which the job started execution.
    • endTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected LocalDateTime endTime
      The instant at which the job finished execution
    • executionDuration

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected int executionDuration
      The duration (in seconds) for which the job should be allowed to run - a value of 0 is intended to mean unlimited - returned at /{jobs}/{job-id}/executionduration
    • destruction

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected LocalDateTime destruction
      The time at which the whole job + records + results will be destroyed. returned at /{jobs}/{job-id}/destruction
    • parameters

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected List<Parameter> parameters
      The parameters to the job (where appropriate) can also be retrieved at /{jobs}/{job-id}/parameters
    • results

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected List<ResultReference> results
      The results for the job - can also be retrieved at /{jobs}/{job-id}/results
    • errorSummary

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected ErrorSummary errorSummary
    • jobInfo

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected Job.JobInfo jobInfo
      This is arbitrary information that can be added to the job description by the UWS implementation.
    • version

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected String version
      note that this attribute is actually required by the 1.1 specification - however remains optional in the schema for backwards compatibility. It will be formally required in the next major revision.
  • Constructor Details

  • Method Details

    • getJobId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String getJobId()
      Gets the value of the jobId property.
      Returns:
      possible object is String
    • setJobId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setJobId(String value)
      Sets the value of the jobId property.
      Parameters:
      value - allowed object is String
    • getRunId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String getRunId()
      this is a client supplied identifier - the UWS system does nothing other than to return it as part of the description of the job
      Returns:
      possible object is String
    • setRunId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setRunId(String value)
      Sets the value of the runId property.
      Parameters:
      value - allowed object is String
      See Also:
    • getOwnerId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String getOwnerId()
      the owner (creator) of the job - this should be expressed as a string that can be parsed in accordance with IVOA security standards. If there was no authenticated job creator then this should be set to NULL.
      Returns:
      possible object is String
    • setOwnerId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setOwnerId(String value)
      Sets the value of the ownerId property.
      Parameters:
      value - allowed object is String
      See Also:
    • getPhase

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public ExecutionPhase getPhase()
      the execution phase - returned at /{jobs}/{job-id}/phase
      Returns:
      possible object is ExecutionPhase
    • setPhase

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setPhase(ExecutionPhase value)
      Sets the value of the phase property.
      Parameters:
      value - allowed object is ExecutionPhase
      See Also:
    • getQuote

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public LocalDateTime getQuote()
      A Quote predicts when the job is likely to complete - returned at /{jobs}/{job-id}/quote "don't know" is encoded by setting to the XML null value xsi:nil="true"
      Returns:
      possible object is String
    • setQuote

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setQuote(LocalDateTime value)
      Sets the value of the quote property.
      Parameters:
      value - allowed object is String
      See Also:
    • getCreationTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public LocalDateTime getCreationTime()
      Note that the version 1.1 of the specification requires that this element be present. It is optional only in versions 1.x of the schema for backwards compatibility. 2.0+ versions of the schema will make this formally mandatory in an XML sense.
      Returns:
      possible object is String
    • setCreationTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setCreationTime(LocalDateTime value)
      Sets the value of the creationTime property.
      Parameters:
      value - allowed object is String
      See Also:
    • getStartTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public LocalDateTime getStartTime()
      The instant at which the job started execution.
      Returns:
      possible object is String
    • setStartTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setStartTime(LocalDateTime value)
      Sets the value of the startTime property.
      Parameters:
      value - allowed object is String
      See Also:
    • getEndTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public LocalDateTime getEndTime()
      The instant at which the job finished execution
      Returns:
      possible object is String
    • setEndTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setEndTime(LocalDateTime value)
      Sets the value of the endTime property.
      Parameters:
      value - allowed object is String
      See Also:
    • getExecutionDuration

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public int getExecutionDuration()
      The duration (in seconds) for which the job should be allowed to run - a value of 0 is intended to mean unlimited - returned at /{jobs}/{job-id}/executionduration
    • setExecutionDuration

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setExecutionDuration(int value)
      Sets the value of the executionDuration property.
    • getDestruction

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public LocalDateTime getDestruction()
      The time at which the whole job + records + results will be destroyed. returned at /{jobs}/{job-id}/destruction
      Returns:
      possible object is String
    • setDestruction

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setDestruction(LocalDateTime value)
      Sets the value of the destruction property.
      Parameters:
      value - allowed object is String
      See Also:
    • getErrorSummary

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public ErrorSummary getErrorSummary()
      Gets the value of the errorSummary property.
      Returns:
      possible object is ErrorSummary
    • setErrorSummary

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setErrorSummary(ErrorSummary value)
      Sets the value of the errorSummary property.
      Parameters:
      value - allowed object is ErrorSummary
    • getJobInfo

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job.JobInfo getJobInfo()
      This is arbitrary information that can be added to the job description by the UWS implementation.
      Returns:
      possible object is Job.JobInfo
    • setJobInfo

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setJobInfo(Job.JobInfo value)
      Sets the value of the jobInfo property.
      Parameters:
      value - allowed object is Job.JobInfo
      See Also:
    • getVersion

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String getVersion()
      note that this attribute is actually required by the 1.1 specification - however remains optional in the schema for backwards compatibility. It will be formally required in the next major revision.
      Returns:
      possible object is String
    • setVersion

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setVersion(String value)
      Sets the value of the version property.
      Parameters:
      value - allowed object is String
      See Also:
    • getParameters

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public List<Parameter> getParameters()
    • setParameters

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setParameters(List<Parameter> parameters)
    • getResults

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public List<ResultReference> getResults()
    • setResults

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setResults(List<ResultReference> results)
    • equals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public boolean equals(Object object)
      Overrides:
      equals in class Object
    • hashCode

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String toString()
      Overrides:
      toString in class Object
    • append

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
      Specified by:
      append in interface org.jvnet.jaxb.lang.ToString
    • appendFields

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
      Specified by:
      appendFields in interface org.jvnet.jaxb.lang.ToString
    • withJobId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withJobId(String value)
    • withRunId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withRunId(String value)
    • withOwnerId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withOwnerId(String value)
    • withPhase

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withPhase(ExecutionPhase value)
    • withQuote

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withQuote(LocalDateTime value)
    • withCreationTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withCreationTime(LocalDateTime value)
    • withStartTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withStartTime(LocalDateTime value)
    • withEndTime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withEndTime(LocalDateTime value)
    • withExecutionDuration

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withExecutionDuration(int value)
    • withDestruction

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withDestruction(LocalDateTime value)
    • withErrorSummary

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withErrorSummary(ErrorSummary value)
    • withJobInfo

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withJobInfo(Job.JobInfo value)
    • withVersion

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withVersion(String value)
    • withParameters

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withParameters(Parameter... values)
    • withParameters

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withParameters(Collection<Parameter> values)
    • withParameters

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withParameters(List<Parameter> parameters)
    • withResults

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withResults(ResultReference... values)
    • withResults

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withResults(Collection<ResultReference> values)
    • withResults

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Job withResults(List<ResultReference> results)
    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void mergeFrom(Object left, Object right)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom
    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom
    • createNewInstance

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Object createNewInstance()
      Specified by:
      createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom