Class DescribeServiceJobResponse

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

  • Method Details

    • hasAttempts

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

    • attempts

      public final List<ServiceJobAttemptDetail> attempts()

      A list of job attempts associated with the service 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 hasAttempts() method.

      Returns:
      A list of job attempts associated with the service job.

    • createdAt

      public final Long createdAt()

      The Unix timestamp (in milliseconds) for when the service job was created.

      Returns:
      The Unix timestamp (in milliseconds) for when the service job was created.

    • isTerminated

      public final Boolean isTerminated()

      Indicates whether the service job has been terminated.

      Returns:
      Indicates whether the service job has been terminated.

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the service job.

      Returns:
      The Amazon Resource Name (ARN) of the service job.

    • jobId

      public final String jobId()

      The job ID for the service job.

      Returns:
      The job ID for the service job.

    • jobName

      public final String jobName()

      The name of the service job.

      Returns:
      The name of the service job.

    • jobQueue

      public final String jobQueue()

      The ARN of the job queue that the service job is associated with.

      Returns:
      The ARN of the job queue that the service job is associated with.

    • latestAttempt

      public final LatestServiceJobAttempt latestAttempt()

      The latest attempt associated with the service job.

      Returns:
      The latest attempt associated with the service job.

    • retryStrategy

      public final ServiceJobRetryStrategy retryStrategy()

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

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

    • schedulingPriority

      public final Integer schedulingPriority()

      The scheduling priority of the service job.

      Returns:
      The scheduling priority of the service job.

    • 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, this value is 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, this value is SAGEMAKER_TRAINING.
      See Also:

    • serviceJobTypeAsString

      public final String serviceJobTypeAsString()

      The type of service job. For SageMaker Training jobs, this value is 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, this value is SAGEMAKER_TRAINING.
      See Also:

    • shareIdentifier

      public final String shareIdentifier()

      The share identifier for the service job. This is used for fair-share scheduling.

      Returns:
      The share identifier for the service job. This is used for fair-share scheduling.

    • startedAt

      public final Long startedAt()

      The Unix timestamp (in milliseconds) for when the service job was started.

      Returns:
      The Unix timestamp (in milliseconds) for when the service job was started.

    • status

      public final ServiceJobStatus status()

      The current status of the service job.

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

      Returns:
      The current status of the service job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the service job.

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

      Returns:
      The current status of the service job.
      See Also:

    • statusReason

      public final String statusReason()

      A short, human-readable string to provide more details for the current status of the service job.

      Returns:
      A short, human-readable string to provide more details for the current status of the service job.

    • stoppedAt

      public final Long stoppedAt()

      The Unix timestamp (in milliseconds) for when the service job stopped running.

      Returns:
      The Unix timestamp (in milliseconds) for when the service job stopped running.

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

    • timeoutConfig

      public final ServiceJobTimeout timeoutConfig()

      The timeout configuration for the service job.

      Returns:
      The timeout configuration for the service job.

    • toBuilder

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

    • builder

      public static DescribeServiceJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeServiceJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.