Class GetCommandInvocationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetCommandInvocationRequest.Builder,
GetCommandInvocationRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
(Required) The parent command ID of the invocation plugin.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
(Required) The ID of the managed node targeted by the command.final String
The name of the step for which you want detailed results.static Class
<? extends GetCommandInvocationRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
commandId
(Required) The parent command ID of the invocation plugin.
- Returns:
- (Required) The parent command ID of the invocation plugin.
-
instanceId
(Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
- Returns:
- (Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
-
pluginName
The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like
aws:RunShellScript
.To find the
PluginName
, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with theCommandId
andDetails
parameters. ThePluginName
is theName
attribute of theCommandPlugin
object in theCommandPlugins
list.- Returns:
- The name of the step for which you want detailed results. If the document contains only one step, you can
omit the name and details for that step. If the document contains more than one step, you must specify
the name of the step for which you want to view details. Be sure to specify the name of the step, not the
name of a plugin like
aws:RunShellScript
.To find the
PluginName
, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with theCommandId
andDetails
parameters. ThePluginName
is theName
attribute of theCommandPlugin
object in theCommandPlugins
list.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetCommandInvocationRequest.Builder,
GetCommandInvocationRequest> - Specified by:
toBuilder
in classSsmRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-