Package software.amazon.awssdk.services.batch.model

Class DescribeServiceJobResponse

    • Method Detail

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

      • hasCapacityUsage

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

      • capacityUsage

        public final List<ServiceJobCapacityUsageDetail> capacityUsage()

        The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.

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

        Returns:
        The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.

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

      • scheduledAt

        public final Long scheduledAt()

        The Unix timestamp (in milliseconds) for when the service job was scheduled. This represents when the service job was dispatched to SageMaker and the service job transitioned to the SCHEDULED state.

        Returns:
        The Unix timestamp (in milliseconds) for when the service job was scheduled. This represents when the service job was dispatched to SageMaker and the service job transitioned to the SCHEDULED state.

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

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

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

      • quotaShareName

        public final String quotaShareName()

        The name of the quota share that the service job is associated with.

        Returns:
        The name of the quota share that the service job is associated with.

      • preemptionConfiguration

        public final ServiceJobPreemptionConfiguration preemptionConfiguration()

        Specifies the service job behavior when preempted.

        Returns:
        Specifies the service job behavior when preempted.

      • preemptionSummary

        public final ServiceJobPreemptionSummary preemptionSummary()

        Summarizes the preemptions of the service job. This field appears on a service job when it has been preempted.

        Returns:
        Summarizes the preemptions of the service job. This field appears on a service job when it has been preempted.

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

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

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

      • 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