Command (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opsworks.model.Command

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Command
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a command.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Command()

Constructors
Constructor and Description
`Command()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Command`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAcknowledgedAt()` Date and time when the command was acknowledged.
`String`	`getCommandId()` The command ID.
`String`	`getCompletedAt()` Date when the command completed.
`String`	`getCreatedAt()` Date and time when the command was run.
`String`	`getDeploymentId()` The command deployment ID.
`Integer`	`getExitCode()` The command exit code.
`String`	`getInstanceId()` The ID of the instance where the command was executed.
`String`	`getLogUrl()` The URL of the command log.
`String`	`getStatus()` The command status:
`String`	`getType()` The command type:
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAcknowledgedAt(String acknowledgedAt)` Date and time when the command was acknowledged.
`void`	`setCommandId(String commandId)` The command ID.
`void`	`setCompletedAt(String completedAt)` Date when the command completed.
`void`	`setCreatedAt(String createdAt)` Date and time when the command was run.
`void`	`setDeploymentId(String deploymentId)` The command deployment ID.
`void`	`setExitCode(Integer exitCode)` The command exit code.
`void`	`setInstanceId(String instanceId)` The ID of the instance where the command was executed.
`void`	`setLogUrl(String logUrl)` The URL of the command log.
`void`	`setStatus(String status)` The command status:
`void`	`setType(String type)` The command type:
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Command`	`withAcknowledgedAt(String acknowledgedAt)` Date and time when the command was acknowledged.
`Command`	`withCommandId(String commandId)` The command ID.
`Command`	`withCompletedAt(String completedAt)` Date when the command completed.
`Command`	`withCreatedAt(String createdAt)` Date and time when the command was run.
`Command`	`withDeploymentId(String deploymentId)` The command deployment ID.
`Command`	`withExitCode(Integer exitCode)` The command exit code.
`Command`	`withInstanceId(String instanceId)` The ID of the instance where the command was executed.
`Command`	`withLogUrl(String logUrl)` The URL of the command log.
`Command`	`withStatus(String status)` The command status:
`Command`	`withType(String type)` The command type:

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Command
```
public Command()
```
- Method Detail
  - setCommandId
```
public void setCommandId(String commandId)
```
    The command ID.
    
    Parameters:
    
    commandId - The command ID.
  - getCommandId
```
public String getCommandId()
```
    The command ID.
    
    Returns:
    
    The command ID.
  - withCommandId
```
public Command withCommandId(String commandId)
```
    The command ID.
    
    Parameters:
    
    commandId - The command ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The ID of the instance where the command was executed.
    
    Parameters:
    
    instanceId - The ID of the instance where the command was executed.
  - getInstanceId
```
public String getInstanceId()
```
    The ID of the instance where the command was executed.
    
    Returns:
    
    The ID of the instance where the command was executed.
  - withInstanceId
```
public Command withInstanceId(String instanceId)
```
    The ID of the instance where the command was executed.
    
    Parameters:
    
    instanceId - The ID of the instance where the command was executed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentId
```
public void setDeploymentId(String deploymentId)
```
    The command deployment ID.
    
    Parameters:
    
    deploymentId - The command deployment ID.
  - getDeploymentId
```
public String getDeploymentId()
```
    The command deployment ID.
    
    Returns:
    
    The command deployment ID.
  - withDeploymentId
```
public Command withDeploymentId(String deploymentId)
```
    The command deployment ID.
    
    Parameters:
    
    deploymentId - The command deployment ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(String createdAt)
```
    Date and time when the command was run.
    
    Parameters:
    
    createdAt - Date and time when the command was run.
  - getCreatedAt
```
public String getCreatedAt()
```
    Date and time when the command was run.
    
    Returns:
    
    Date and time when the command was run.
  - withCreatedAt
```
public Command withCreatedAt(String createdAt)
```
    Date and time when the command was run.
    
    Parameters:
    
    createdAt - Date and time when the command was run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAcknowledgedAt
```
public void setAcknowledgedAt(String acknowledgedAt)
```
    Date and time when the command was acknowledged.
    
    Parameters:
    
    acknowledgedAt - Date and time when the command was acknowledged.
  - getAcknowledgedAt
```
public String getAcknowledgedAt()
```
    Date and time when the command was acknowledged.
    
    Returns:
    
    Date and time when the command was acknowledged.
  - withAcknowledgedAt
```
public Command withAcknowledgedAt(String acknowledgedAt)
```
    Date and time when the command was acknowledged.
    
    Parameters:
    
    acknowledgedAt - Date and time when the command was acknowledged.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletedAt
```
public void setCompletedAt(String completedAt)
```
    Date when the command completed.
    
    Parameters:
    
    completedAt - Date when the command completed.
  - getCompletedAt
```
public String getCompletedAt()
```
    Date when the command completed.
    
    Returns:
    
    Date when the command completed.
  - withCompletedAt
```
public Command withCompletedAt(String completedAt)
```
    Date when the command completed.
    
    Parameters:
    
    completedAt - Date when the command completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The command status:
    - failed
    - successful
    - skipped
    - pending
    Parameters:
    status - The command status:
    
    failed
    
    successful
    
    skipped
    
    pending
  - getStatus
```
public String getStatus()
```
    The command status:
    - failed
    - successful
    - skipped
    - pending
    Returns:
    The command status:
    
    failed
    
    successful
    
    skipped
    
    pending
  - withStatus
```
public Command withStatus(String status)
```
    The command status:
    - failed
    - successful
    - skipped
    - pending
    Parameters:
    status - The command status:
    
    failed
    
    successful
    
    skipped
    
    pending
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExitCode
```
public void setExitCode(Integer exitCode)
```
    The command exit code.
    
    Parameters:
    
    exitCode - The command exit code.
  - getExitCode
```
public Integer getExitCode()
```
    The command exit code.
    
    Returns:
    
    The command exit code.
  - withExitCode
```
public Command withExitCode(Integer exitCode)
```
    The command exit code.
    
    Parameters:
    
    exitCode - The command exit code.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogUrl
```
public void setLogUrl(String logUrl)
```
    The URL of the command log.
    
    Parameters:
    
    logUrl - The URL of the command log.
  - getLogUrl
```
public String getLogUrl()
```
    The URL of the command log.
    
    Returns:
    
    The URL of the command log.
  - withLogUrl
```
public Command withLogUrl(String logUrl)
```
    The URL of the command log.
    
    Parameters:
    
    logUrl - The URL of the command log.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The command type:
    - configure
    - deploy
    - execute_recipes
    - install_dependencies
    - restart
    - rollback
    - setup
    - start
    - stop
    - undeploy
    - update_custom_cookbooks
    - update_dependencies
    Parameters:
    type - The command type:
    
    configure
    
    deploy
    
    execute_recipes
    
    install_dependencies
    
    restart
    
    rollback
    
    setup
    
    start
    
    stop
    
    undeploy
    
    update_custom_cookbooks
    
    update_dependencies
  - getType
```
public String getType()
```
    The command type:
    - configure
    - deploy
    - execute_recipes
    - install_dependencies
    - restart
    - rollback
    - setup
    - start
    - stop
    - undeploy
    - update_custom_cookbooks
    - update_dependencies
    Returns:
    The command type:
    
    configure
    
    deploy
    
    execute_recipes
    
    install_dependencies
    
    restart
    
    rollback
    
    setup
    
    start
    
    stop
    
    undeploy
    
    update_custom_cookbooks
    
    update_dependencies
  - withType
```
public Command withType(String type)
```
    The command type:
    - configure
    - deploy
    - execute_recipes
    - install_dependencies
    - restart
    - rollback
    - setup
    - start
    - stop
    - undeploy
    - update_custom_cookbooks
    - update_dependencies
    Parameters:
    type - The command type:
    
    configure
    
    deploy
    
    execute_recipes
    
    install_dependencies
    
    restart
    
    rollback
    
    setup
    
    start
    
    stop
    
    undeploy
    
    update_custom_cookbooks
    
    update_dependencies
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Command clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Command

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Command

Method Detail

setCommandId

getCommandId

withCommandId

setInstanceId

getInstanceId

withInstanceId

setDeploymentId

getDeploymentId

withDeploymentId

setCreatedAt

getCreatedAt

withCreatedAt

setAcknowledgedAt

getAcknowledgedAt

withAcknowledgedAt

setCompletedAt

getCompletedAt

withCompletedAt

setStatus

getStatus

withStatus

setExitCode

getExitCode

withExitCode

setLogUrl

getLogUrl

withLogUrl

setType

getType

withType

toString

equals

hashCode

clone

marshall