DocumentParameter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.DocumentParameter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentParameter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Parameters specified in a System Manager document that execute on the server when the command is run.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentParameter()

Constructors
Constructor and Description
`DocumentParameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentParameter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDefaultValue()` If specified, the default values for the parameters.
`String`	`getDescription()` A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
`String`	`getName()` The name of the parameter.
`String`	`getType()` The type of parameter.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefaultValue(String defaultValue)` If specified, the default values for the parameters.
`void`	`setDescription(String description)` A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
`void`	`setName(String name)` The name of the parameter.
`void`	`setType(DocumentParameterType type)` The type of parameter.
`void`	`setType(String type)` The type of parameter.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DocumentParameter`	`withDefaultValue(String defaultValue)` If specified, the default values for the parameters.
`DocumentParameter`	`withDescription(String description)` A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
`DocumentParameter`	`withName(String name)` The name of the parameter.
`DocumentParameter`	`withType(DocumentParameterType type)` The type of parameter.
`DocumentParameter`	`withType(String type)` The type of parameter.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentParameter
```
public DocumentParameter()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the parameter.
    
    Parameters:
    
    name - The name of the parameter.
  - getName
```
public String getName()
```
    The name of the parameter.
    
    Returns:
    
    The name of the parameter.
  - withName
```
public DocumentParameter withName(String name)
```
    The name of the parameter.
    
    Parameters:
    
    name - The name of the parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of parameter. The type can be either String or StringList.
    
    Parameters:
    
    type - The type of parameter. The type can be either String or StringList.
    
    See Also:
    
    DocumentParameterType
  - getType
```
public String getType()
```
    The type of parameter. The type can be either String or StringList.
    
    Returns:
    
    The type of parameter. The type can be either String or StringList.
    
    See Also:
    
    DocumentParameterType
  - withType
```
public DocumentParameter withType(String type)
```
    The type of parameter. The type can be either String or StringList.
    
    Parameters:
    
    type - The type of parameter. The type can be either String or StringList.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentParameterType
  - setType
```
public void setType(DocumentParameterType type)
```
    The type of parameter. The type can be either String or StringList.
    
    Parameters:
    
    type - The type of parameter. The type can be either String or StringList.
    
    See Also:
    
    DocumentParameterType
  - withType
```
public DocumentParameter withType(DocumentParameterType type)
```
    The type of parameter. The type can be either String or StringList.
    
    Parameters:
    
    type - The type of parameter. The type can be either String or StringList.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentParameterType
  - setDescription
```
public void setDescription(String description)
```
    A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
    
    Parameters:
    
    description - A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
  - getDescription
```
public String getDescription()
```
    A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
    
    Returns:
    
    A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
  - withDescription
```
public DocumentParameter withDescription(String description)
```
    A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
    
    Parameters:
    
    description - A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
    If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
    
    Parameters:
    
    defaultValue - If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
  - getDefaultValue
```
public String getDefaultValue()
```
    If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
    
    Returns:
    
    If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
  - withDefaultValue
```
public DocumentParameter withDefaultValue(String defaultValue)
```
    If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
    
    Parameters:
    
    defaultValue - If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocumentParameter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DocumentParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentParameter

Method Detail

setName

getName

withName

setType

getType

withType

setType

withType

setDescription

getDescription

withDescription

setDefaultValue

getDefaultValue

withDefaultValue

toString

equals

hashCode

clone

marshall