java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.deadline.model.DeadlineRequest
    - - software.amazon.awssdk.services.deadline.model.CreateJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateJobRequest
extends DeadlineRequest
implements ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateJobRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Attachments`	`attachments()`	The attachments for the job.
`static CreateJobRequest.Builder`	`builder()`
`String`	`clientToken()`	The unique token which the server uses to recognize retries of the same request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`farmId()`	The farm ID of the farm to connect to the job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameters()`	For responses, this returns true if the service returned a value for the Parameters property.
`Integer`	`maxFailedTasksCount()`	The number of task failures before the job stops running and is marked as `FAILED`.
`Integer`	`maxRetriesPerTask()`	The maximum number of retries for a job.
`Map<String,JobParameter>`	`parameters()`	The parameters for the job.
`Integer`	`priority()`	The priority of the job on a scale of 1 to 100.
`String`	`queueId()`	The ID of the queue that the job is submitted to.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateJobRequest.Builder>`	`serializableBuilderClass()`
`String`	`storageProfileId()`	The storage profile ID for the storage profile to connect to the job.
`CreateJobTargetTaskRunStatus`	`targetTaskRunStatus()`	The initial status of the job's tasks when they are created.
`String`	`targetTaskRunStatusAsString()`	The initial status of the job's tasks when they are created.
`String`	`template()`	The job template to use for this job.
`JobTemplateType`	`templateType()`	The file type for the job template.
`String`	`templateTypeAsString()`	The file type for the job template.
`CreateJobRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - attachments
```
public final Attachments attachments()
```
    The attachments for the job. Attach files required for the job to run to a render job.
    
    Returns:
    
    The attachments for the job. Attach files required for the job to run to a render job.
  - clientToken
```
public final String clientToken()
```
    The unique token which the server uses to recognize retries of the same request.
    
    Returns:
    
    The unique token which the server uses to recognize retries of the same request.
  - farmId
```
public final String farmId()
```
    The farm ID of the farm to connect to the job.
    
    Returns:
    
    The farm ID of the farm to connect to 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 for a job.
    
    Returns:
    
    The maximum number of retries for a 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 priority of the job on a scale of 1 to 100. The highest priority is 1.
    
    Returns:
    
    The priority of the job on a scale of 1 to 100. The highest priority is 1.
  - queueId
```
public final String queueId()
```
    The ID of the queue that the job is submitted to.
    
    Returns:
    
    The ID of the queue that the job is submitted to.
  - storageProfileId
```
public final String storageProfileId()
```
    The storage profile ID for the storage profile to connect to the job.
    
    Returns:
    
    The storage profile ID for the storage profile to connect to the job.
  - targetTaskRunStatus
```
public final CreateJobTargetTaskRunStatus targetTaskRunStatus()
```
    The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.
    
    If the service returns an enum value that is not available in the current SDK version, targetTaskRunStatus will return CreateJobTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTaskRunStatusAsString().
    
    Returns:
    
    The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.
    
    See Also:
    
    CreateJobTargetTaskRunStatus
  - targetTaskRunStatusAsString
```
public final String targetTaskRunStatusAsString()
```
    The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.
    
    If the service returns an enum value that is not available in the current SDK version, targetTaskRunStatus will return CreateJobTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTaskRunStatusAsString().
    
    Returns:
    
    The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.
    
    See Also:
    
    CreateJobTargetTaskRunStatus
  - template
```
public final String template()
```
    The job template to use for this job.
    
    Returns:
    
    The job template to use for this job.
  - templateType
```
public final JobTemplateType templateType()
```
    The file type for the job template.
    
    If the service returns an enum value that is not available in the current SDK version, templateType will return JobTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().
    
    Returns:
    
    The file type for the job template.
    
    See Also:
    
    JobTemplateType
  - templateTypeAsString
```
public final String templateTypeAsString()
```
    The file type for the job template.
    
    If the service returns an enum value that is not available in the current SDK version, templateType will return JobTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().
    
    Returns:
    
    The file type for the job template.
    
    See Also:
    
    JobTemplateType
  - toBuilder
```
public CreateJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
    
    Specified by:
    
    toBuilder in class DeadlineRequest
  - builder
```
public static CreateJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

attachments

clientToken

farmId

maxFailedTasksCount

maxRetriesPerTask

hasParameters

parameters

priority

queueId

storageProfileId

targetTaskRunStatus

targetTaskRunStatusAsString

template

templateType

templateTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields