Class GetBatchJobExecutionResponse

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

  • Method Details

    • applicationId

      public final String applicationId()

      The identifier of the application.

      Returns:
      The identifier of the application.

    • 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 the batch job execution ended.

      Returns:
      The timestamp when the batch job execution ended.

    • executionId

      public final String executionId()

      The unique identifier for this batch job execution.

      Returns:
      The unique identifier for this batch job execution.

    • jobId

      public final String jobId()

      The unique identifier for this batch job.

      Returns:
      The unique identifier for this batch job.

    • jobName

      public final String jobName()

      The name of this batch job.

      Returns:
      The name of this batch job.

    • jobStepRestartMarker

      public final JobStepRestartMarker jobStepRestartMarker()

      The restart steps information for the most recent restart operation.

      Returns:
      The restart steps information for the most recent restart operation.

    • jobType

      public final BatchJobType jobType()

      The type of job.

      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 job.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The type of job.

      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 job.
      See Also:

    • jobUser

      public final String jobUser()

      The user for the job.

      Returns:
      The user for the job.

    • 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 the batch job execution started.

      Returns:
      The timestamp when the batch job execution started.

    • status

      public final BatchJobExecutionStatus status()

      The status of the 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 the batch job execution.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the 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 the batch job execution.
      See Also:

    • statusReason

      public final String statusReason()

      The reason for the reported status.

      Returns:
      The reason for the reported status.

    • toBuilder

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

    • builder

      public static GetBatchJobExecutionResponse.Builder builder()

    • serializableBuilderClass

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