Class GetJobResponse

    • Method Detail

      • attachments

        public final Attachments attachments()

        The attachments for the job.

        Returns:
        The attachments for the job.
      • createdAt

        public final Instant createdAt()

        The date and time the resource was created.

        Returns:
        The date and time the resource was created.
      • createdBy

        public final String createdBy()

        The user or system that created this resource.

        Returns:
        The user or system that created this resource.
      • description

        public final String description()

        The description of the job.

        Returns:
        The description of the job.
      • endedAt

        public final Instant endedAt()

        The date and time the resource ended running.

        Returns:
        The date and time the resource ended running.
      • jobId

        public final String jobId()

        The job ID.

        Returns:
        The job ID.
      • lifecycleStatusMessage

        public final String lifecycleStatusMessage()

        A message that communicates the status of the life cycle for the job.

        Returns:
        A message that communicates the status of the life cycle for the job.
      • maxFailedTasksCount

        public final Integer maxFailedTasksCount()

        The number of task failures before the job stops running and is marked as FAILED.

        Returns:
        The number of task failures before the job stops running and is marked as FAILED.
      • maxRetriesPerTask

        public final Integer maxRetriesPerTask()

        The maximum number of retries per failed tasks.

        Returns:
        The maximum number of retries per failed tasks.
      • name

        public final String name()

        The name of the job.

        Returns:
        The name of the job.
      • hasParameters

        public final boolean hasParameters()
        For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • parameters

        public final Map<String,​JobParameter> parameters()

        The parameters for the job.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

        Returns:
        The parameters for the job.
      • priority

        public final Integer priority()

        The job priority.

        Returns:
        The job priority.
      • startedAt

        public final Instant startedAt()

        The date and time the resource started running.

        Returns:
        The date and time the resource started running.
      • storageProfileId

        public final String storageProfileId()

        The storage profile ID associated with the job.

        Returns:
        The storage profile ID associated with the job.
      • taskRunStatusAsString

        public final String taskRunStatusAsString()

        The task run status for the job.

        If the service returns an enum value that is not available in the current SDK version, taskRunStatus will return TaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskRunStatusAsString().

        Returns:
        The task run status for the job.
        See Also:
        TaskRunStatus
      • taskRunStatusCounts

        public final Map<TaskRunStatus,​Integer> taskRunStatusCounts()

        The number of tasks running on the job.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTaskRunStatusCounts() method.

        Returns:
        The number of tasks running on the job.
      • hasTaskRunStatusCounts

        public final boolean hasTaskRunStatusCounts()
        For responses, this returns true if the service returned a value for the TaskRunStatusCounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • taskRunStatusCountsAsStrings

        public final Map<String,​Integer> taskRunStatusCountsAsStrings()

        The number of tasks running on the job.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTaskRunStatusCounts() method.

        Returns:
        The number of tasks running on the job.
      • updatedAt

        public final Instant updatedAt()

        The date and time the resource was updated.

        Returns:
        The date and time the resource was updated.
      • updatedBy

        public final String updatedBy()

        The user or system that updated this resource.

        Returns:
        The user or system that updated this resource.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object