Class CreateJobRequest

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>

  • Method Details

    • 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.

    • 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.

    • 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.

    • 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:

    • 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:

    • priority

      public final Integer priority()

      The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

      Returns:
      The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

    • 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.

    • 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.

    • 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 job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

      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 job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.
      See Also:

    • targetTaskRunStatusAsString

      public final String targetTaskRunStatusAsString()

      The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

      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 job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.
      See Also:

    • 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 each task.

      Returns:
      The maximum number of retries for each task.

    • maxWorkerCount

      public final Integer maxWorkerCount()

      The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

      You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

      If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.

      Returns:
      The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

      You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

      If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.

    • sourceJobId

      public final String sourceJobId()

      The job ID for the source job.

      Returns:
      The job ID for the source job.

    • toBuilder

      public CreateJobRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
      Specified by:
      toBuilder in class DeadlineRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.