ApiCommandWithSteps (cloudera-manager-api-swagger 7.13.1 API)
Date: 2026-05-19

com.cloudera.api.swagger.model

## Class ApiCommandWithSteps

- java.lang.Object
- - com.cloudera.api.swagger.model.ApiCommand
  - - com.cloudera.api.swagger.model.ApiCommandWithSteps

-     @Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
                 date="2026-05-19T08:00:51.241Z[Etc/UTC]")
      public class ApiCommandWithSteps
      extends ApiCommand

  Provides detailed information about a submitted command including all steps and a summary of subcommands. <p>There are two types of commands: synchronous and asynchronous. Synchronous commands complete immediately, and their results are passed back in the returned command object after the execution of an API call. Outside of that returned object, there is no way to check the result of a synchronous command.</p> <p>Asynchronous commands have unique non-negative IDs. They may still be running when the API call returns. Clients can check the status of such commands using the API.</p>

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ApiCommandWithSteps()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `ApiCommandWithSteps` | `addStepsItem(ApiCommandStep stepsItem)`
    `ApiCommandWithSteps` | `displayName(String displayName)`
    `boolean` | `equals(Object o)`
    `String` | `getDisplayName()` The command display name.
    `List<ApiCommandStep>` | `getSteps()` The steps of the command.
    `int` | `hashCode()`
    `void` | `setDisplayName(String displayName)`
    `void` | `setSteps(List<ApiCommandStep> steps)`
    `ApiCommandWithSteps` | `steps(List<ApiCommandStep> steps)`
    `String` | `toString()`

    - ### Methods inherited from class com.cloudera.api.swagger.model.ApiCommand

      `active, canRetry, children, clusterRef, endTime, getChildren, getClusterRef, getEndTime, getHostRef, getId, getName, getParent, getResultDataUrl, getResultMessage, getRoleRef, getServiceRef, getStartTime, hostRef, id, isActive, isCanRetry, isSuccess, name, parent, resultDataUrl, resultMessage, roleRef, serviceRef, setActive, setCanRetry, setChildren, setClusterRef, setEndTime, setHostRef, setId, setName, setParent, setResultDataUrl, setResultMessage, setRoleRef, setServiceRef, setStartTime, setSuccess, startTime, success`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### ApiCommandWithSteps

          public ApiCommandWithSteps()

  - ### Method Detail

    - #### displayName

          public ApiCommandWithSteps displayName(String displayName)

    - #### getDisplayName

          public String getDisplayName()

      The command display name.
      Returns:
        displayName

    - #### setDisplayName

          public void setDisplayName(String displayName)

    - #### steps

          public ApiCommandWithSteps steps(List<ApiCommandStep> steps)

    - #### addStepsItem

          public ApiCommandWithSteps addStepsItem(ApiCommandStep stepsItem)

    - #### getSteps

          public List<ApiCommandStep> getSteps()

      The steps of the command.
      Returns:
        steps

    - #### setSteps

          public void setSteps(List<ApiCommandStep> steps)

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `ApiCommand`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `ApiCommand`

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `ApiCommand`

Copyright © 2026. All rights reserved.