V4JobRequestProjection (genie 4.0.0-rc.1 API)

All Known Implementing Classes:

JobEntity
```
public interface V4JobRequestProjection
```
Projection of just the fields needed for a V4 JobRequest.

Since:

4.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.List<CriterionEntity>`	`getClusterCriteria()` Get all the cluster criteria.
`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.Set<FileEntity>`	`getConfigs()` Get all the configuration files for this job.
`java.util.Set<FileEntity>`	`getDependencies()` Get all the dependency files for this job.
`java.util.Optional<java.lang.String>`	`getDescription()` Get the description of this resource.
`java.util.Optional<java.lang.String>`	`getEmail()` Get the email of the user associated with this job if they desire an email notification at completion of the job.
`java.util.Optional<java.lang.String>`	`getGenieUserGroup()` Get the user group for this job.
`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.String>`	`getMetadata()` Get the metadata of this entity which is unstructured JSON.
`java.lang.String`	`getName()` Get the name of the resource.
`java.util.Optional<java.lang.String>`	`getRequestedAgentConfigExt()` Get the extension configuration of a job agent configuration.
`java.util.Optional<java.lang.String>`	`getRequestedAgentEnvironmentExt()` Get the extension configuration of a job agent environment.
`java.util.List<java.lang.String>`	`getRequestedApplications()` Get any applications requested by their id.
`java.util.Optional<java.lang.String>`	`getRequestedArchiveLocationPrefix()` Get the archive location prefix uri for a job.
`java.util.Optional<java.lang.Integer>`	`getRequestedCpu()` Get the number of CPU's requested to run this job.
`java.util.Map<java.lang.String,java.lang.String>`	`getRequestedEnvironmentVariables()` Get all the environment variables that were requested be added to the Job Runtime environment by the user.
`java.util.Optional<java.lang.String>`	`getRequestedJobDirectoryLocation()` Get the requested directory on disk where the Genie job working directory should be placed if a user asked to override the default.
`java.util.Optional<java.lang.Integer>`	`getRequestedMemory()` Get the memory requested to run this job with.
`java.util.Optional<java.lang.Integer>`	`getRequestedTimeout()` Get the timeout (in seconds) requested by the user for this job.
`java.util.Optional<FileEntity>`	`getSetupFile()` Get the setup file for this resource.
`java.util.Set<TagEntity>`	`getTags()` Get the tags for the job.
`java.lang.String`	`getUniqueId()` Get the unique identifier for this entity.
`java.lang.String`	`getUser()` Get the user who created the resource.
`java.lang.String`	`getVersion()` Get the version.
`boolean`	`isArchivingDisabled()` Get whether log archiving was requested to be disabled for this job or not.
`boolean`	`isInteractive()` Get whether the job was an interactive job or not when launched.
`boolean`	`isRequestedId()` Get whether the unique identifier of this request was requested by the user or not.

- Method Detail
  - getUniqueId
```
java.lang.String getUniqueId()
```
    Get the unique identifier for this entity.
    
    Returns:
    
    The globally unique identifier of this entity
  - isRequestedId
```
boolean isRequestedId()
```
    Get whether the unique identifier of this request was requested by the user or not.
    
    Returns:
    
    True if it was requested by the user
  - getName
```
java.lang.String getName()
```
    Get the name of the resource.
    
    Returns:
    
    The name of the resource
  - getUser
```
java.lang.String getUser()
```
    Get the user who created the resource.
    
    Returns:
    
    The user who created the resource
  - getVersion
```
java.lang.String getVersion()
```
    Get the version.
    
    Returns:
    
    The version of the resource (job, app, etc)
  - getDescription
```
java.util.Optional<java.lang.String> getDescription()
```
    Get the description of this resource.
    
    Returns:
    
    The description which could be null so it's wrapped in Optional
  - getMetadata
```
java.util.Optional<java.lang.String> getMetadata()
```
    Get the metadata of this entity which is unstructured JSON.
    
    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
  - 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
  - getRequestedEnvironmentVariables
```
java.util.Map<java.lang.String,java.lang.String> getRequestedEnvironmentVariables()
```
    Get all the environment variables that were requested be added to the Job Runtime environment by the user.
    
    Returns:
    
    The requested environment variables
  - getRequestedJobDirectoryLocation
```
java.util.Optional<java.lang.String> getRequestedJobDirectoryLocation()
```
    Get the requested directory on disk where the Genie job working directory should be placed if a user asked to override the default.
    
    Returns:
    
    The requested job directory location wrapped in an Optional
  - getRequestedAgentEnvironmentExt
```
java.util.Optional<java.lang.String> getRequestedAgentEnvironmentExt()
```
    Get the extension configuration of a job agent environment.
    
    Returns:
    
    The extension configuration (as valid JSON string) if it exists wrapped in an Optional
  - getRequestedAgentConfigExt
```
java.util.Optional<java.lang.String> getRequestedAgentConfigExt()
```
    Get the extension configuration of a job agent configuration.
    
    Returns:
    
    The extension configuration (as valid JSON string) if it exists wrapped in an Optional
  - isInteractive
```
boolean isInteractive()
```
    Get whether the job was an interactive job or not when launched.
    
    Returns:
    
    true if the job was interactive
  - getSetupFile
```
java.util.Optional<FileEntity> getSetupFile()
```
    Get the setup file for this resource.
    
    Returns:
    
    The setup file
  - getGenieUserGroup
```
java.util.Optional<java.lang.String> getGenieUserGroup()
```
    Get the user group for this job.
    
    Returns:
    
    the user group
  - 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
  - getDependencies
```
java.util.Set<FileEntity> getDependencies()
```
    Get all the dependency files for this job.
    
    Returns:
    
    The set of dependencies
  - getConfigs
```
java.util.Set<FileEntity> getConfigs()
```
    Get all the configuration files for this job.
    
    Returns:
    
    The set of configs
  - isArchivingDisabled
```
boolean isArchivingDisabled()
```
    Get whether log archiving was requested to be disabled for this job or not.
    
    Returns:
    
    true if log archival was disabled
  - getEmail
```
java.util.Optional<java.lang.String> getEmail()
```
    Get the email of the user associated with this job if they desire an email notification at completion of the job.
    
    Returns:
    
    The email
  - getRequestedCpu
```
java.util.Optional<java.lang.Integer> getRequestedCpu()
```
    Get the number of CPU's requested to run this job.
    
    Returns:
    
    The number of CPU's as an Optional
  - 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
  - getRequestedTimeout
```
java.util.Optional<java.lang.Integer> getRequestedTimeout()
```
    Get the timeout (in seconds) requested by the user for this job.
    
    Returns:
    
    The number of seconds before a timeout as an Optional
  - getRequestedApplications
```
java.util.List<java.lang.String> getRequestedApplications()
```
    Get any applications requested by their id.
    
    Returns:
    
    The applications
  - getRequestedArchiveLocationPrefix
```
java.util.Optional<java.lang.String> getRequestedArchiveLocationPrefix()
```
    Get the archive location prefix uri for a job.
    
    Returns:
    
    archive location prefix uri for a job wrapped in a Optional

Interface V4JobRequestProjection

Method Summary

Method Detail

getUniqueId

isRequestedId

getName

getUser

getVersion

getDescription

getMetadata

getCommandArgs

getTags

getGrouping

getGroupingInstance

getRequestedEnvironmentVariables

getRequestedJobDirectoryLocation

getRequestedAgentEnvironmentExt

getRequestedAgentConfigExt

isInteractive

getSetupFile

getGenieUserGroup

getClusterCriteria

getCommandCriterion

getDependencies

getConfigs

isArchivingDisabled

getEmail

getRequestedCpu

getRequestedMemory

getRequestedTimeout

getRequestedApplications

getRequestedArchiveLocationPrefix