Package com.azure.quantum.jobs.models

Class JobDetails

java.lang.Object
com.azure.quantum.jobs.models.JobDetails
public final class JobDetails extends Object
Job details.

  • Constructor Details

    • JobDetails

      public JobDetails()

  • Method Details

    • getId

      public String getId()
      Get the id property: The job id.
      Returns:
      the id value.

    • setId

      public JobDetails setId(String id)
      Set the id property: The job id.
      Parameters:
      id - the id value to set.
      Returns:
      the JobDetails object itself.

    • getName

      public String getName()
      Get the name property: The job name. Is not required for the name to be unique and it's only used for display purposes.
      Returns:
      the name value.

    • setName

      public JobDetails setName(String name)
      Set the name property: The job name. Is not required for the name to be unique and it's only used for display purposes.
      Parameters:
      name - the name value to set.
      Returns:
      the JobDetails object itself.

    • getContainerUri

      public String getContainerUri()
      Get the containerUri property: The blob container SAS uri, the container is used to host job data.
      Returns:
      the containerUri value.

    • setContainerUri

      public JobDetails setContainerUri(String containerUri)
      Set the containerUri property: The blob container SAS uri, the container is used to host job data.
      Parameters:
      containerUri - the containerUri value to set.
      Returns:
      the JobDetails object itself.

    • getInputDataUri

      public String getInputDataUri()
      Get the inputDataUri property: The input blob SAS uri, if specified, it will override the default input blob in the container.
      Returns:
      the inputDataUri value.

    • setInputDataUri

      public JobDetails setInputDataUri(String inputDataUri)
      Set the inputDataUri property: The input blob SAS uri, if specified, it will override the default input blob in the container.
      Parameters:
      inputDataUri - the inputDataUri value to set.
      Returns:
      the JobDetails object itself.

    • getInputDataFormat

      public String getInputDataFormat()
      Get the inputDataFormat property: The format of the input data.
      Returns:
      the inputDataFormat value.

    • setInputDataFormat

      public JobDetails setInputDataFormat(String inputDataFormat)
      Set the inputDataFormat property: The format of the input data.
      Parameters:
      inputDataFormat - the inputDataFormat value to set.
      Returns:
      the JobDetails object itself.

    • getInputParams

      public Object getInputParams()
      Get the inputParams property: The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data.
      Returns:
      the inputParams value.

    • setInputParams

      public JobDetails setInputParams(Object inputParams)
      Set the inputParams property: The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data.
      Parameters:
      inputParams - the inputParams value to set.
      Returns:
      the JobDetails object itself.

    • getProviderId

      public String getProviderId()
      Get the providerId property: The unique identifier for the provider.
      Returns:
      the providerId value.

    • setProviderId

      public JobDetails setProviderId(String providerId)
      Set the providerId property: The unique identifier for the provider.
      Parameters:
      providerId - the providerId value to set.
      Returns:
      the JobDetails object itself.

    • getTarget

      public String getTarget()
      Get the target property: The target identifier to run the job.
      Returns:
      the target value.

    • setTarget

      public JobDetails setTarget(String target)
      Set the target property: The target identifier to run the job.
      Parameters:
      target - the target value to set.
      Returns:
      the JobDetails object itself.

    • getMetadata

      public Map<String,String> getMetadata()
      Get the metadata property: The job metadata. Metadata provides client the ability to store client-specific information.
      Returns:
      the metadata value.

    • setMetadata

      public JobDetails setMetadata(Map<String,String> metadata)
      Set the metadata property: The job metadata. Metadata provides client the ability to store client-specific information.
      Parameters:
      metadata - the metadata value to set.
      Returns:
      the JobDetails object itself.

    • getOutputDataUri

      public String getOutputDataUri()
      Get the outputDataUri property: The output blob SAS uri. When a job finishes successfully, results will be uploaded to this blob.
      Returns:
      the outputDataUri value.

    • setOutputDataUri

      public JobDetails setOutputDataUri(String outputDataUri)
      Set the outputDataUri property: The output blob SAS uri. When a job finishes successfully, results will be uploaded to this blob.
      Parameters:
      outputDataUri - the outputDataUri value to set.
      Returns:
      the JobDetails object itself.

    • getOutputDataFormat

      public String getOutputDataFormat()
      Get the outputDataFormat property: The format of the output data.
      Returns:
      the outputDataFormat value.

    • setOutputDataFormat

      public JobDetails setOutputDataFormat(String outputDataFormat)
      Set the outputDataFormat property: The format of the output data.
      Parameters:
      outputDataFormat - the outputDataFormat value to set.
      Returns:
      the JobDetails object itself.

    • getStatus

      public JobStatus getStatus()
      Get the status property: The job status.
      Returns:
      the status value.

    • getCreationTime

      public OffsetDateTime getCreationTime()
      Get the creationTime property: The creation time of the job.
      Returns:
      the creationTime value.

    • getBeginExecutionTime

      public OffsetDateTime getBeginExecutionTime()
      Get the beginExecutionTime property: The time when the job began execution.
      Returns:
      the beginExecutionTime value.

    • getEndExecutionTime

      public OffsetDateTime getEndExecutionTime()
      Get the endExecutionTime property: The time when the job finished execution.
      Returns:
      the endExecutionTime value.

    • getCancellationTime

      public OffsetDateTime getCancellationTime()
      Get the cancellationTime property: The time when a job was successfully cancelled.
      Returns:
      the cancellationTime value.

    • getErrorData

      public ErrorData getErrorData()
      Get the errorData property: The error data for the job. This is expected only when Status 'Failed'.
      Returns:
      the errorData value.