Class CommandInvocation
- All Implemented Interfaces:
Serializable
,Cloneable
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The command against which this invocation was requested.User-specified information about the command, such as a brief description of what the command should do.The document name that was requested for execution.The instance ID in which this invocation was requested.The time and date the request was sent to this instance.Whether or not the invocation succeeded, failed, or is pending.Gets the trace output sent by the agent.int
hashCode()
void
setCommandId
(String commandId) The command against which this invocation was requested.void
setCommandPlugins
(Collection<CommandPlugin> commandPlugins) void
setComment
(String comment) User-specified information about the command, such as a brief description of what the command should do.void
setDocumentName
(String documentName) The document name that was requested for execution.void
setInstanceId
(String instanceId) The instance ID in which this invocation was requested.void
setRequestedDateTime
(Date requestedDateTime) The time and date the request was sent to this instance.void
setStatus
(CommandInvocationStatus status) Whether or not the invocation succeeded, failed, or is pending.void
Whether or not the invocation succeeded, failed, or is pending.void
setTraceOutput
(String traceOutput) Gets the trace output sent by the agent.toString()
Returns a string representation of this object; useful for testing and debugging.withCommandId
(String commandId) The command against which this invocation was requested.withCommandPlugins
(CommandPlugin... commandPlugins) NOTE: This method appends the values to the existing list (if any).withCommandPlugins
(Collection<CommandPlugin> commandPlugins) withComment
(String comment) User-specified information about the command, such as a brief description of what the command should do.withDocumentName
(String documentName) The document name that was requested for execution.withInstanceId
(String instanceId) The instance ID in which this invocation was requested.withRequestedDateTime
(Date requestedDateTime) The time and date the request was sent to this instance.withStatus
(CommandInvocationStatus status) Whether or not the invocation succeeded, failed, or is pending.withStatus
(String status) Whether or not the invocation succeeded, failed, or is pending.withTraceOutput
(String traceOutput) Gets the trace output sent by the agent.
-
Constructor Details
-
CommandInvocation
public CommandInvocation()
-
-
Method Details
-
setCommandId
The command against which this invocation was requested.
- Parameters:
commandId
- The command against which this invocation was requested.
-
getCommandId
The command against which this invocation was requested.
- Returns:
- The command against which this invocation was requested.
-
withCommandId
The command against which this invocation was requested.
- Parameters:
commandId
- The command against which this invocation was requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInstanceId
The instance ID in which this invocation was requested.
- Parameters:
instanceId
- The instance ID in which this invocation was requested.
-
getInstanceId
The instance ID in which this invocation was requested.
- Returns:
- The instance ID in which this invocation was requested.
-
withInstanceId
The instance ID in which this invocation was requested.
- Parameters:
instanceId
- The instance ID in which this invocation was requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setComment
User-specified information about the command, such as a brief description of what the command should do.
- Parameters:
comment
- User-specified information about the command, such as a brief description of what the command should do.
-
getComment
User-specified information about the command, such as a brief description of what the command should do.
- Returns:
- User-specified information about the command, such as a brief description of what the command should do.
-
withComment
User-specified information about the command, such as a brief description of what the command should do.
- Parameters:
comment
- User-specified information about the command, such as a brief description of what the command should do.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDocumentName
The document name that was requested for execution.
- Parameters:
documentName
- The document name that was requested for execution.
-
getDocumentName
The document name that was requested for execution.
- Returns:
- The document name that was requested for execution.
-
withDocumentName
The document name that was requested for execution.
- Parameters:
documentName
- The document name that was requested for execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRequestedDateTime
The time and date the request was sent to this instance.
- Parameters:
requestedDateTime
- The time and date the request was sent to this instance.
-
getRequestedDateTime
The time and date the request was sent to this instance.
- Returns:
- The time and date the request was sent to this instance.
-
withRequestedDateTime
The time and date the request was sent to this instance.
- Parameters:
requestedDateTime
- The time and date the request was sent to this instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
Whether or not the invocation succeeded, failed, or is pending.
- Parameters:
status
- Whether or not the invocation succeeded, failed, or is pending.- See Also:
-
getStatus
Whether or not the invocation succeeded, failed, or is pending.
- Returns:
- Whether or not the invocation succeeded, failed, or is pending.
- See Also:
-
withStatus
Whether or not the invocation succeeded, failed, or is pending.
- Parameters:
status
- Whether or not the invocation succeeded, failed, or is pending.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStatus
Whether or not the invocation succeeded, failed, or is pending.
- Parameters:
status
- Whether or not the invocation succeeded, failed, or is pending.- See Also:
-
withStatus
Whether or not the invocation succeeded, failed, or is pending.
- Parameters:
status
- Whether or not the invocation succeeded, failed, or is pending.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setTraceOutput
Gets the trace output sent by the agent.
- Parameters:
traceOutput
- Gets the trace output sent by the agent.
-
getTraceOutput
Gets the trace output sent by the agent.
- Returns:
- Gets the trace output sent by the agent.
-
withTraceOutput
Gets the trace output sent by the agent.
- Parameters:
traceOutput
- Gets the trace output sent by the agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCommandPlugins
- Returns:
-
setCommandPlugins
- Parameters:
commandPlugins
-
-
withCommandPlugins
NOTE: This method appends the values to the existing list (if any). Use
setCommandPlugins(java.util.Collection)
orwithCommandPlugins(java.util.Collection)
if you want to override the existing values.- Parameters:
commandPlugins
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCommandPlugins
- Parameters:
commandPlugins
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-