com.netflix.genie.web.data.entities.projections.v4

Interface FinishedJobProjection

All Superinterfaces:

AuditProjection, BaseProjection, IdProjection, UniqueIdProjection

All Known Implementing Classes:

JobEntity

public interface FinishedJobProjection
extends BaseProjection

Projection for a job entity that reached a terminal status.

Since:

4.0.0

Method Summary

Modifier and Type	Method and Description
java.util.List<ApplicationEntity>	getApplications() Get the applications used to run this job.
java.util.Optional<java.lang.String>	getArchiveLocation() Get the location where the job was archived.
java.util.Optional<ClusterEntity>	getCluster() Get the cluster that ran or is currently running a given job.
java.util.List<CriterionEntity>	getClusterCriteria() Get all the cluster criteria.
java.util.Optional<CommandEntity>	getCommand() Get the command that ran or is currently running a given job.
java.util.List<java.lang.String>	getCommandArgs() Get the command arguments the user supplied for this job.
CriterionEntity	getCommandCriterion() Get the command criterion for this job.
java.util.Optional<java.lang.Integer>	getExitCode() Get the exit code from the process that ran the job.
java.util.Optional<java.time.Instant>	getFinished() Get when the job was finished.
java.util.Optional<java.lang.String>	getGrouping() Get the grouping this job is a part of.
java.util.Optional<java.lang.String>	getGroupingInstance() Get the instance identifier of a grouping.
java.util.Optional<java.lang.Integer>	getMemoryUsed() Get the amount of memory (in MB) that this job is/was run with.
java.util.Optional<java.lang.String>	getMetadata() Get the metadata of this entity which is unstructured JSON.
java.util.Optional<java.lang.Integer>	getNumAttachments() Get the number of attachments.
java.util.Optional<java.lang.String>	getRequestAgentClientHostname() Get the hostname of the agent that requested this job be run if there was one.
java.util.Optional<java.lang.String>	getRequestAgentClientVersion() Get the version of the agent that requested this job be run if there was one.
java.util.Optional<java.lang.String>	getRequestApiClientHostname() Get the request api client hostname.
java.util.Optional<java.lang.String>	getRequestApiClientUserAgent() Get the user agent.
java.util.Optional<java.lang.Integer>	getRequestedMemory() Get the memory requested to run this job with.
java.util.Optional<java.time.Instant>	getStarted() Get when the job was started.
java.util.Optional<java.lang.String>	getStatusMsg() Get the current status message of the job.
java.util.Set<TagEntity>	getTags() Get the tags for the job.

Methods inherited from interface com.netflix.genie.web.data.entities.projections.BaseProjection

getDescription, getName, getStatus, getUser, getVersion

Methods inherited from interface com.netflix.genie.web.data.entities.projections.UniqueIdProjection

getUniqueId

Methods inherited from interface com.netflix.genie.web.data.entities.projections.AuditProjection

getCreated, getUpdated

Methods inherited from interface com.netflix.genie.web.data.entities.projections.IdProjection

getId

Method Detail

getTags

java.util.Set<TagEntity> getTags()

Get the tags for the job.

Returns:

Any tags that were sent in when job was originally requested

getGrouping

java.util.Optional<java.lang.String> getGrouping()

Get the grouping this job is a part of. e.g. scheduler job name for job run many times

Returns:

The grouping

getGroupingInstance

java.util.Optional<java.lang.String> getGroupingInstance()

Get the instance identifier of a grouping. e.g. the run id of a given scheduled job

Returns:

The grouping instance

getStatusMsg

java.util.Optional<java.lang.String> getStatusMsg()

Get the current status message of the job.

Returns:

The status message

getStarted

java.util.Optional<java.time.Instant> getStarted()

Get when the job was started.

Returns:

The start date

getFinished

java.util.Optional<java.time.Instant> getFinished()

Get when the job was finished.

Returns:

The finish date

getMetadata

java.util.Optional<java.lang.String> getMetadata()

Get the metadata of this entity which is unstructured JSON.

Specified by:

getMetadata in interface BaseProjection

Returns:

Optional of the metadata json node represented as a string

getCommandArgs

java.util.List<java.lang.String> getCommandArgs()

Get the command arguments the user supplied for this job.

Returns:

The command arguments

getRequestedMemory

java.util.Optional<java.lang.Integer> getRequestedMemory()

Get the memory requested to run this job with.

Returns:

The amount of memory the user requested for this job in MB as an Optional

getRequestApiClientHostname

java.util.Optional<java.lang.String> getRequestApiClientHostname()

Get the request api client hostname.

Returns:

Optional of the client host

getRequestApiClientUserAgent

java.util.Optional<java.lang.String> getRequestApiClientUserAgent()

Get the user agent.

Returns:

Optional of the user agent

getNumAttachments

java.util.Optional<java.lang.Integer> getNumAttachments()

Get the number of attachments.

Returns:

The number of attachments as an Optional

getRequestAgentClientHostname

java.util.Optional<java.lang.String> getRequestAgentClientHostname()

Get the hostname of the agent that requested this job be run if there was one.

Returns:

The hostname wrapped in an Optional

getRequestAgentClientVersion

java.util.Optional<java.lang.String> getRequestAgentClientVersion()

Get the version of the agent that requested this job be run if there was one.

Returns:

The version wrapped in an Optional

getExitCode

java.util.Optional<java.lang.Integer> getExitCode()

Get the exit code from the process that ran the job.

Returns:

The exit code or -1 if the job hasn't finished yet

getArchiveLocation

java.util.Optional<java.lang.String> getArchiveLocation()

Get the location where the job was archived.

Returns:

The archive location

getMemoryUsed

java.util.Optional<java.lang.Integer> getMemoryUsed()

Get the amount of memory (in MB) that this job is/was run with.

Returns:

The memory as an Optional as it could be null

getClusterCriteria

java.util.List<CriterionEntity> getClusterCriteria()

Get all the cluster criteria.

Returns:

The criteria in priority order

getCommandCriterion

CriterionEntity getCommandCriterion()

Get the command criterion for this job.

Returns:

The command criterion for this job

getApplications

java.util.List<ApplicationEntity> getApplications()

Get the applications used to run this job.

Returns:

The applications

getCluster

java.util.Optional<ClusterEntity> getCluster()

Get the cluster that ran or is currently running a given job.

Returns:

The cluster entity

getCommand

java.util.Optional<CommandEntity> getCommand()

Get the command that ran or is currently running a given job.

Returns:

The command entity