public class CommandPlugin
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Describes plugin details.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
name
The name of the plugin.
|
private java.lang.String |
output
Output of the plugin execution.
|
private java.lang.String |
outputS3BucketName
The S3 bucket where the responses to the command executions should be
stored.
|
private java.lang.String |
outputS3KeyPrefix
The S3 directory path inside the bucket where the responses to the
command executions should be stored.
|
private java.lang.Integer |
responseCode
A numeric response code generated after executing the plugin.
|
private java.util.Date |
responseFinishDateTime
The time the plugin stopped executing.
|
private java.util.Date |
responseStartDateTime
The time the plugin started executing.
|
private java.lang.String |
status
The status of this plugin.
|
Constructor and Description |
---|
CommandPlugin() |
Modifier and Type | Method and Description |
---|---|
CommandPlugin |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getName()
The name of the plugin.
|
java.lang.String |
getOutput()
Output of the plugin execution.
|
java.lang.String |
getOutputS3BucketName()
The S3 bucket where the responses to the command executions should be
stored.
|
java.lang.String |
getOutputS3KeyPrefix()
The S3 directory path inside the bucket where the responses to the
command executions should be stored.
|
java.lang.Integer |
getResponseCode()
A numeric response code generated after executing the plugin.
|
java.util.Date |
getResponseFinishDateTime()
The time the plugin stopped executing.
|
java.util.Date |
getResponseStartDateTime()
The time the plugin started executing.
|
java.lang.String |
getStatus()
The status of this plugin.
|
int |
hashCode() |
void |
setName(java.lang.String name)
The name of the plugin.
|
void |
setOutput(java.lang.String output)
Output of the plugin execution.
|
void |
setOutputS3BucketName(java.lang.String outputS3BucketName)
The S3 bucket where the responses to the command executions should be
stored.
|
void |
setOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix)
The S3 directory path inside the bucket where the responses to the
command executions should be stored.
|
void |
setResponseCode(java.lang.Integer responseCode)
A numeric response code generated after executing the plugin.
|
void |
setResponseFinishDateTime(java.util.Date responseFinishDateTime)
The time the plugin stopped executing.
|
void |
setResponseStartDateTime(java.util.Date responseStartDateTime)
The time the plugin started executing.
|
void |
setStatus(CommandPluginStatus status)
The status of this plugin.
|
void |
setStatus(java.lang.String status)
The status of this plugin.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CommandPlugin |
withName(java.lang.String name)
The name of the plugin.
|
CommandPlugin |
withOutput(java.lang.String output)
Output of the plugin execution.
|
CommandPlugin |
withOutputS3BucketName(java.lang.String outputS3BucketName)
The S3 bucket where the responses to the command executions should be
stored.
|
CommandPlugin |
withOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix)
The S3 directory path inside the bucket where the responses to the
command executions should be stored.
|
CommandPlugin |
withResponseCode(java.lang.Integer responseCode)
A numeric response code generated after executing the plugin.
|
CommandPlugin |
withResponseFinishDateTime(java.util.Date responseFinishDateTime)
The time the plugin stopped executing.
|
CommandPlugin |
withResponseStartDateTime(java.util.Date responseStartDateTime)
The time the plugin started executing.
|
CommandPlugin |
withStatus(CommandPluginStatus status)
The status of this plugin.
|
CommandPlugin |
withStatus(java.lang.String status)
The status of this plugin.
|
private java.lang.String name
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
private java.lang.String status
The status of this plugin. You can execute a document with multiple plugins.
private java.lang.Integer responseCode
A numeric response code generated after executing the plugin.
private java.util.Date responseStartDateTime
The time the plugin started executing.
private java.util.Date responseFinishDateTime
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
private java.lang.String output
Output of the plugin execution.
private java.lang.String outputS3BucketName
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
private java.lang.String outputS3KeyPrefix
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
public void setName(java.lang.String name)
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
name
- The name of the plugin. Must be one of the following:
aws:updateAgent, aws:domainjoin, aws:applications,
aws:runPowerShellScript, aws:psmodule, aws:cloudWatch,
aws:runShellScript, or aws:updateSSMAgent.public java.lang.String getName()
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
public CommandPlugin withName(java.lang.String name)
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
name
- The name of the plugin. Must be one of the following:
aws:updateAgent, aws:domainjoin, aws:applications,
aws:runPowerShellScript, aws:psmodule, aws:cloudWatch,
aws:runShellScript, or aws:updateSSMAgent.public void setStatus(java.lang.String status)
The status of this plugin. You can execute a document with multiple plugins.
status
- The status of this plugin. You can execute a document with
multiple plugins.CommandPluginStatus
public java.lang.String getStatus()
The status of this plugin. You can execute a document with multiple plugins.
CommandPluginStatus
public CommandPlugin withStatus(java.lang.String status)
The status of this plugin. You can execute a document with multiple plugins.
status
- The status of this plugin. You can execute a document with
multiple plugins.CommandPluginStatus
public void setStatus(CommandPluginStatus status)
The status of this plugin. You can execute a document with multiple plugins.
status
- The status of this plugin. You can execute a document with
multiple plugins.CommandPluginStatus
public CommandPlugin withStatus(CommandPluginStatus status)
The status of this plugin. You can execute a document with multiple plugins.
status
- The status of this plugin. You can execute a document with
multiple plugins.CommandPluginStatus
public void setResponseCode(java.lang.Integer responseCode)
A numeric response code generated after executing the plugin.
responseCode
- A numeric response code generated after executing the plugin.public java.lang.Integer getResponseCode()
A numeric response code generated after executing the plugin.
public CommandPlugin withResponseCode(java.lang.Integer responseCode)
A numeric response code generated after executing the plugin.
responseCode
- A numeric response code generated after executing the plugin.public void setResponseStartDateTime(java.util.Date responseStartDateTime)
The time the plugin started executing.
responseStartDateTime
- The time the plugin started executing.public java.util.Date getResponseStartDateTime()
The time the plugin started executing.
public CommandPlugin withResponseStartDateTime(java.util.Date responseStartDateTime)
The time the plugin started executing.
responseStartDateTime
- The time the plugin started executing.public void setResponseFinishDateTime(java.util.Date responseFinishDateTime)
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
responseFinishDateTime
- The time the plugin stopped executing. Could stop prematurely if,
for example, a cancel command was sent.public java.util.Date getResponseFinishDateTime()
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
public CommandPlugin withResponseFinishDateTime(java.util.Date responseFinishDateTime)
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
responseFinishDateTime
- The time the plugin stopped executing. Could stop prematurely if,
for example, a cancel command was sent.public void setOutput(java.lang.String output)
Output of the plugin execution.
output
- Output of the plugin execution.public java.lang.String getOutput()
Output of the plugin execution.
public CommandPlugin withOutput(java.lang.String output)
Output of the plugin execution.
output
- Output of the plugin execution.public void setOutputS3BucketName(java.lang.String outputS3BucketName)
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
outputS3BucketName
- The S3 bucket where the responses to the command executions should
be stored. This was requested when issuing the command.public java.lang.String getOutputS3BucketName()
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
public CommandPlugin withOutputS3BucketName(java.lang.String outputS3BucketName)
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
outputS3BucketName
- The S3 bucket where the responses to the command executions should
be stored. This was requested when issuing the command.public void setOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix)
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
outputS3KeyPrefix
- The S3 directory path inside the bucket where the responses to the
command executions should be stored. This was requested when
issuing the command.public java.lang.String getOutputS3KeyPrefix()
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
public CommandPlugin withOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix)
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
outputS3KeyPrefix
- The S3 directory path inside the bucket where the responses to the
command executions should be stored. This was requested when
issuing the command.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CommandPlugin clone()
clone
in class java.lang.Object