Class StartJobRunRequest

    • Method Detail

      • applicationId

        public final String applicationId()

        The ID of the application on which to run the job.

        Returns:
        The ID of the application on which to run the job.
      • clientToken

        public final String clientToken()

        The client idempotency token of the job run to start. Its value must be unique for each request.

        Returns:
        The client idempotency token of the job run to start. Its value must be unique for each request.
      • executionRoleArn

        public final String executionRoleArn()

        The execution role ARN for the job run.

        Returns:
        The execution role ARN for the job run.
      • jobDriver

        public final JobDriver jobDriver()

        The job driver for the job run.

        Returns:
        The job driver for the job run.
      • configurationOverrides

        public final ConfigurationOverrides configurationOverrides()

        The configuration overrides for the job run.

        Returns:
        The configuration overrides for the job run.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final Map<String,​String> tags()

        The tags assigned to the job run.

        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 hasTags() method.

        Returns:
        The tags assigned to the job run.
      • executionTimeoutMinutes

        public final Long executionTimeoutMinutes()

        The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

        Returns:
        The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.
      • name

        public final String name()

        The optional job run name. This doesn't have to be unique.

        Returns:
        The optional job run name. This doesn't have to be unique.
      • mode

        public final JobRunMode mode()

        The mode of the job run when it starts.

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

        Returns:
        The mode of the job run when it starts.
        See Also:
        JobRunMode
      • modeAsString

        public final String modeAsString()

        The mode of the job run when it starts.

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

        Returns:
        The mode of the job run when it starts.
        See Also:
        JobRunMode
      • retryPolicy

        public final RetryPolicy retryPolicy()

        The retry policy when job run starts.

        Returns:
        The retry policy when job run starts.
      • 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