com.amazonaws.services.simplesystemsmanagement.model.GetCommandInvocationRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssm Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.simplesystemsmanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetCommandInvocationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* (Required) The parent command ID of the invocation plugin.
*
*/
private String commandId;
/**
*
* (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.
*
*/
private String instanceId;
/**
*
* 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 the CommandId and Details
* parameters. The PluginName is the Name attribute of the CommandPlugin
* object in the CommandPlugins list.
*
*/
private String pluginName;
/**
*
* (Required) The parent command ID of the invocation plugin.
*
*
* @param commandId
* (Required) The parent command ID of the invocation plugin.
*/
public void setCommandId(String commandId) {
this.commandId = commandId;
}
/**
*
* (Required) The parent command ID of the invocation plugin.
*
*
* @return (Required) The parent command ID of the invocation plugin.
*/
public String getCommandId() {
return this.commandId;
}
/**
*
* (Required) The parent command ID of the invocation plugin.
*
*
* @param commandId
* (Required) The parent command ID of the invocation plugin.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCommandInvocationRequest withCommandId(String commandId) {
setCommandId(commandId);
return this;
}
/**
*
* (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.
*
*
* @param 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.
*/
public void setInstanceId(String instanceId) {
this.instanceId = 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.
*
*
* @return (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.
*/
public String getInstanceId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCommandInvocationRequest withInstanceId(String instanceId) {
setInstanceId(instanceId);
return this;
}
/**
*
* 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 the CommandId and Details
* parameters. The PluginName is the Name attribute of the CommandPlugin
* object in the CommandPlugins list.
*
*
* @param 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 the CommandId and
* Details parameters. The PluginName is the Name attribute of the
* CommandPlugin object in the CommandPlugins list.
*/
public void setPluginName(String pluginName) {
this.pluginName = 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 the CommandId and Details
* parameters. The PluginName is the Name attribute of the CommandPlugin
* object in the CommandPlugins list.
*
*
* @return 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 the CommandId and
* Details parameters. The PluginName is the Name attribute of the
* CommandPlugin object in the CommandPlugins list.
*/
public String getPluginName() {
return this.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 the CommandId and Details
* parameters. The PluginName is the Name attribute of the CommandPlugin
* object in the CommandPlugins list.
*
*
* @param 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 the CommandId and
* Details parameters. The PluginName is the Name attribute of the
* CommandPlugin object in the CommandPlugins list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetCommandInvocationRequest withPluginName(String pluginName) {
setPluginName(pluginName);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCommandId() != null)
sb.append("CommandId: ").append(getCommandId()).append(",");
if (getInstanceId() != null)
sb.append("InstanceId: ").append(getInstanceId()).append(",");
if (getPluginName() != null)
sb.append("PluginName: ").append(getPluginName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetCommandInvocationRequest == false)
return false;
GetCommandInvocationRequest other = (GetCommandInvocationRequest) obj;
if (other.getCommandId() == null ^ this.getCommandId() == null)
return false;
if (other.getCommandId() != null && other.getCommandId().equals(this.getCommandId()) == false)
return false;
if (other.getInstanceId() == null ^ this.getInstanceId() == null)
return false;
if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false)
return false;
if (other.getPluginName() == null ^ this.getPluginName() == null)
return false;
if (other.getPluginName() != null && other.getPluginName().equals(this.getPluginName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCommandId() == null) ? 0 : getCommandId().hashCode());
hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
hashCode = prime * hashCode + ((getPluginName() == null) ? 0 : getPluginName().hashCode());
return hashCode;
}
@Override
public GetCommandInvocationRequest clone() {
return (GetCommandInvocationRequest) super.clone();
}
}