Class SubmitServiceJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.batch.model.BatchRequest
software.amazon.awssdk.services.batch.model.SubmitServiceJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SubmitServiceJobRequest.Builder,SubmitServiceJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class SubmitServiceJobRequest extends BatchRequest implements ToCopyableBuilder<SubmitServiceJobRequest.Builder,SubmitServiceJobRequest>

  • Method Details

    • jobName

      public final String jobName()

      The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

      Returns:
      The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

    • jobQueue

      public final String jobQueue()

      The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING.

      Returns:
      The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING.

    • retryStrategy

      public final ServiceJobRetryStrategy retryStrategy()

      The retry strategy to use for failed service jobs that are submitted with this service job request.

      Returns:
      The retry strategy to use for failed service jobs that are submitted with this service job request.

    • schedulingPriority

      public final Integer schedulingPriority()

      The scheduling priority of the service job. Valid values are integers between 0 and 9999.

      Returns:
      The scheduling priority of the service job. Valid values are integers between 0 and 9999.

    • serviceRequestPayload

      public final String serviceRequestPayload()

      The request, in JSON, for the service that the SubmitServiceJob operation is queueing.

      Returns:
      The request, in JSON, for the service that the SubmitServiceJob operation is queueing.

    • serviceJobType

      public final ServiceJobType serviceJobType()

      The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

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

      Returns:
      The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.
      See Also:

    • serviceJobTypeAsString

      public final String serviceJobTypeAsString()

      The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

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

      Returns:
      The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.
      See Also:

    • shareIdentifier

      public final String shareIdentifier()

      The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.

      Returns:
      The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.

    • timeoutConfig

      public final ServiceJobTimeout timeoutConfig()

      The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.

      Returns:
      The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.

    • 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 that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

      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 that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

    • clientToken

      public final String clientToken()

      A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.

      Returns:
      A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.

    • toBuilder

      public SubmitServiceJobRequest.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<SubmitServiceJobRequest.Builder,SubmitServiceJobRequest>
      Specified by:
      toBuilder in class BatchRequest
      Returns:
      a builder for type T

    • builder

      public static SubmitServiceJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SubmitServiceJobRequest.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.