Class BatchGetStepItem

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

The details of a step returned in a batch get operation.

See Also:

  • Method Details

    • farmId

      public final String farmId()

      The farm ID of the step.

      Returns:
      The farm ID of the step.

    • queueId

      public final String queueId()

      The queue ID of the step.

      Returns:
      The queue ID of the step.

    • jobId

      public final String jobId()

      The job ID of the step.

      Returns:
      The job ID of the step.

    • stepId

      public final String stepId()

      The step ID.

      Returns:
      The step ID.

    • name

      public final String name()

      The name of the step.

      Returns:
      The name of the step.

    • lifecycleStatus

      public final StepLifecycleStatus lifecycleStatus()

      The life cycle status of the step.

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

      Returns:
      The life cycle status of the step.
      See Also:

    • lifecycleStatusAsString

      public final String lifecycleStatusAsString()

      The life cycle status of the step.

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

      Returns:
      The life cycle status of the step.
      See Also:

    • lifecycleStatusMessage

      public final String lifecycleStatusMessage()

      A message that communicates the status of the life cycle.

      Returns:
      A message that communicates the status of the life cycle.

    • taskRunStatus

      public final TaskRunStatus taskRunStatus()

      The task run status for the step.

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

      Returns:
      The task run status for the step.
      See Also:

    • taskRunStatusAsString

      public final String taskRunStatusAsString()

      The task run status for the step.

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

      Returns:
      The task run status for the step.
      See Also:

    • taskRunStatusCounts

      public final Map<TaskRunStatus,Integer> taskRunStatusCounts()

      The number of tasks for each run status for the step.

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

      Returns:
      The number of tasks for each run status for the step.

    • hasTaskRunStatusCounts

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

    • taskRunStatusCountsAsStrings

      public final Map<String,Integer> taskRunStatusCountsAsStrings()

      The number of tasks for each run status for the step.

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

      Returns:
      The number of tasks for each run status for the step.

    • taskFailureRetryCount

      public final Integer taskFailureRetryCount()

      The number of times that tasks failed and were retried.

      Returns:
      The number of times that tasks failed and were retried.

    • targetTaskRunStatus

      public final StepTargetTaskRunStatus targetTaskRunStatus()

      The task status to start with on the step.

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

      Returns:
      The task status to start with on the step.
      See Also:

    • targetTaskRunStatusAsString

      public final String targetTaskRunStatusAsString()

      The task status to start with on the step.

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

      Returns:
      The task status to start with on the step.
      See Also:

    • createdAt

      public final Instant createdAt()

      The date and time the resource was created.

      Returns:
      The date and time the resource was created.

    • createdBy

      public final String createdBy()

      The user or system that created this resource.

      Returns:
      The user or system that created this resource.

    • updatedAt

      public final Instant updatedAt()

      The date and time the resource was updated.

      Returns:
      The date and time the resource was updated.

    • updatedBy

      public final String updatedBy()

      The user or system that updated this resource.

      Returns:
      The user or system that updated this resource.

    • startedAt

      public final Instant startedAt()

      The date and time the resource started running.

      Returns:
      The date and time the resource started running.

    • endedAt

      public final Instant endedAt()

      The date and time the resource ended running.

      Returns:
      The date and time the resource ended running.

    • dependencyCounts

      public final DependencyCounts dependencyCounts()

      The number of dependencies for the step.

      Returns:
      The number of dependencies for the step.

    • requiredCapabilities

      public final StepRequiredCapabilities requiredCapabilities()

      The required capabilities for the step.

      Returns:
      The required capabilities for the step.

    • parameterSpace

      public final ParameterSpace parameterSpace()

      The parameter space for the step.

      Returns:
      The parameter space for the step.

    • description

      public final String description()

      The description of the step.

      Returns:
      The description of the step.

    • toBuilder

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

    • builder

      public static BatchGetStepItem.Builder builder()

    • serializableBuilderClass

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