public class CommandPlugin extends Object implements Serializable, Cloneable
Describes plugin details.
Constructor and Description |
---|
CommandPlugin() |
Modifier and Type | Method and Description |
---|---|
CommandPlugin |
clone() |
boolean |
equals(Object obj) |
String |
getName()
The name of the plugin.
|
String |
getOutput()
Output of the plugin execution.
|
String |
getOutputS3BucketName()
The S3 bucket where the responses to the command executions should be
stored.
|
String |
getOutputS3KeyPrefix()
The S3 directory path inside the bucket where the responses to the
command executions should be stored.
|
Integer |
getResponseCode()
A numeric response code generated after executing the plugin.
|
Date |
getResponseFinishDateTime()
The time the plugin stopped executing.
|
Date |
getResponseStartDateTime()
The time the plugin started executing.
|
String |
getStatus()
The status of this plugin.
|
int |
hashCode() |
void |
setName(String name)
The name of the plugin.
|
void |
setOutput(String output)
Output of the plugin execution.
|
void |
setOutputS3BucketName(String outputS3BucketName)
The S3 bucket where the responses to the command executions should be
stored.
|
void |
setOutputS3KeyPrefix(String outputS3KeyPrefix)
The S3 directory path inside the bucket where the responses to the
command executions should be stored.
|
void |
setResponseCode(Integer responseCode)
A numeric response code generated after executing the plugin.
|
void |
setResponseFinishDateTime(Date responseFinishDateTime)
The time the plugin stopped executing.
|
void |
setResponseStartDateTime(Date responseStartDateTime)
The time the plugin started executing.
|
void |
setStatus(CommandPluginStatus status)
The status of this plugin.
|
void |
setStatus(String status)
The status of this plugin.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CommandPlugin |
withName(String name)
The name of the plugin.
|
CommandPlugin |
withOutput(String output)
Output of the plugin execution.
|
CommandPlugin |
withOutputS3BucketName(String outputS3BucketName)
The S3 bucket where the responses to the command executions should be
stored.
|
CommandPlugin |
withOutputS3KeyPrefix(String outputS3KeyPrefix)
The S3 directory path inside the bucket where the responses to the
command executions should be stored.
|
CommandPlugin |
withResponseCode(Integer responseCode)
A numeric response code generated after executing the plugin.
|
CommandPlugin |
withResponseFinishDateTime(Date responseFinishDateTime)
The time the plugin stopped executing.
|
CommandPlugin |
withResponseStartDateTime(Date responseStartDateTime)
The time the plugin started executing.
|
CommandPlugin |
withStatus(CommandPluginStatus status)
The status of this plugin.
|
CommandPlugin |
withStatus(String status)
The status of this plugin.
|
public void setName(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 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(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(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 String getStatus()
The status of this plugin. You can execute a document with multiple plugins.
CommandPluginStatus
public CommandPlugin withStatus(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(Integer responseCode)
A numeric response code generated after executing the plugin.
responseCode
- A numeric response code generated after executing the plugin.public Integer getResponseCode()
A numeric response code generated after executing the plugin.
public CommandPlugin withResponseCode(Integer responseCode)
A numeric response code generated after executing the plugin.
responseCode
- A numeric response code generated after executing the plugin.public void setResponseStartDateTime(Date responseStartDateTime)
The time the plugin started executing.
responseStartDateTime
- The time the plugin started executing.public Date getResponseStartDateTime()
The time the plugin started executing.
public CommandPlugin withResponseStartDateTime(Date responseStartDateTime)
The time the plugin started executing.
responseStartDateTime
- The time the plugin started executing.public void setResponseFinishDateTime(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 Date getResponseFinishDateTime()
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
public CommandPlugin withResponseFinishDateTime(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(String output)
Output of the plugin execution.
output
- Output of the plugin execution.public String getOutput()
Output of the plugin execution.
public CommandPlugin withOutput(String output)
Output of the plugin execution.
output
- Output of the plugin execution.public void setOutputS3BucketName(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 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(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(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 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(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 String toString()
toString
in class Object
Object.toString()
public CommandPlugin clone()
Copyright © 2018. All rights reserved.