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

Class ServiceJobSummary

    • Method Detail

      • latestAttempt

        public final LatestServiceJobAttempt latestAttempt()

        Information about the latest attempt for the service job.

        Returns:
        Information about the latest attempt for 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<ServiceJobCapacityUsageSummary> capacityUsage()

        The capacity usage information for this service job, including the unit of measure and quantity of resources being used.

        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 capacity usage information for this service job, including the unit of measure and quantity of resources being used.

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

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

      • scheduledAt

        public final Long scheduledAt()

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

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

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

        Returns:
        The share identifier for the job.

      • quotaShareName

        public final String quotaShareName()

        The quota share for the service job.

        Returns:
        The quota share for the service job.

      • 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 string to provide more details on the current status of the service job.

        Returns:
        A short string to provide more details on the current status of the service job.

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

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

      • hashCode

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

      • equals

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

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