Class BatchJobExecutionSummary

java.lang.Object
software.amazon.awssdk.services.m2.model.BatchJobExecutionSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BatchJobExecutionSummary.Builder,BatchJobExecutionSummary>
@Generated("software.amazon.awssdk:codegen") public final class BatchJobExecutionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BatchJobExecutionSummary.Builder,BatchJobExecutionSummary>

A subset of the possible batch job attributes. Used in the batch job list.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      The unique identifier of the application that hosts this batch job.

      Returns:
      The unique identifier of the application that hosts this batch job.

    • batchJobIdentifier

      public final BatchJobIdentifier batchJobIdentifier()

      The unique identifier of this batch job.

      Returns:
      The unique identifier of this batch job.

    • endTime

      public final Instant endTime()

      The timestamp when this batch job execution ended.

      Returns:
      The timestamp when this batch job execution ended.

    • executionId

      public final String executionId()

      The unique identifier of this execution of the batch job.

      Returns:
      The unique identifier of this execution of the batch job.

    • jobId

      public final String jobId()

      The unique identifier of a particular batch job.

      Returns:
      The unique identifier of a particular batch job.

    • jobName

      public final String jobName()

      The name of a particular batch job.

      Returns:
      The name of a particular batch job.

    • jobType

      public final BatchJobType jobType()

      The type of a particular batch job execution.

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

      Returns:
      The type of a particular batch job execution.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The type of a particular batch job execution.

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

      Returns:
      The type of a particular batch job execution.
      See Also:

    • returnCode

      public final String returnCode()

      The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.

      Returns:
      The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.

    • startTime

      public final Instant startTime()

      The timestamp when a particular batch job execution started.

      Returns:
      The timestamp when a particular batch job execution started.

    • status

      public final BatchJobExecutionStatus status()

      The status of a particular batch job execution.

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

      Returns:
      The status of a particular batch job execution.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a particular batch job execution.

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

      Returns:
      The status of a particular batch job execution.
      See Also:

    • toBuilder

      public BatchJobExecutionSummary.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<BatchJobExecutionSummary.Builder,BatchJobExecutionSummary>
      Returns:
      a builder for type T

    • builder

      public static BatchJobExecutionSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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