Class GetStepResponse

    • Method Detail

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

        public final DependencyCounts dependencyCounts()

        The number of dependencies in the step.

        Returns:
        The number of dependencies in the step.
      • description

        public final String description()

        The description of the step.

        Returns:
        The description of the step.
      • endedAt

        public final Instant endedAt()

        The date and time the resource ended running.

        Returns:
        The date and time the resource ended running.
      • lifecycleStatusMessage

        public final String lifecycleStatusMessage()

        A message that describes the lifecycle status of the step.

        Returns:
        A message that describes the lifecycle status of the step.
      • name

        public final String name()

        The name of the step.

        Returns:
        The name of the step.
      • parameterSpace

        public final ParameterSpace parameterSpace()

        A list of step parameters and the combination expression for the step.

        Returns:
        A list of step parameters and the combination expression for the step.
      • requiredCapabilities

        public final StepRequiredCapabilities requiredCapabilities()

        The required capabilities of the step.

        Returns:
        The required capabilities of the step.
      • startedAt

        public final Instant startedAt()

        The date and time the resource started running.

        Returns:
        The date and time the resource started running.
      • stepId

        public final String stepId()

        The step ID.

        Returns:
        The step ID.
      • taskRunStatusCounts

        public final Map<TaskRunStatus,​Integer> taskRunStatusCounts()

        The number of tasks running on the 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 hasTaskRunStatusCounts() method.

        Returns:
        The number of tasks running on the job.
      • 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 running on the 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 hasTaskRunStatusCounts() method.

        Returns:
        The number of tasks running on the job.
      • 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.
      • 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