DocumentParameter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.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
```
A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

See Also:

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`	`getDescription()` Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
`String`	`getExample()` An example illustrating a pattern that need to be replaced in a managed template job document schema.
`String`	`getKey()` Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
`Boolean`	`getOptional()` Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
`String`	`getRegex()` A regular expression of the patterns that need to be replaced in a managed template job document schema.
`int`	`hashCode()`
`Boolean`	`isOptional()` Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
`void`	`setExample(String example)` An example illustrating a pattern that need to be replaced in a managed template job document schema.
`void`	`setKey(String key)` Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
`void`	`setOptional(Boolean optional)` Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
`void`	`setRegex(String regex)` A regular expression of the patterns that need to be replaced in a managed template job document schema.
`String`	`toString()` Returns a string representation of this object.
`DocumentParameter`	`withDescription(String description)` Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
`DocumentParameter`	`withExample(String example)` An example illustrating a pattern that need to be replaced in a managed template job document schema.
`DocumentParameter`	`withKey(String key)` Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
`DocumentParameter`	`withOptional(Boolean optional)` Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
`DocumentParameter`	`withRegex(String regex)` A regular expression of the patterns that need to be replaced in a managed template job document schema.

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

- Constructor Detail
  - DocumentParameter
```
public DocumentParameter()
```
- Method Detail
  - setKey
```
public void setKey(String key)
```
    Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
    
    Parameters:
    
    key - Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
  - getKey
```
public String getKey()
```
    Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
    
    Returns:
    
    Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
  - withKey
```
public DocumentParameter withKey(String key)
```
    Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
    
    Parameters:
    
    key - Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
    
    Parameters:
    
    description - Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
  - getDescription
```
public String getDescription()
```
    Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
    
    Returns:
    
    Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
  - withDescription
```
public DocumentParameter withDescription(String description)
```
    Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
    
    Parameters:
    
    description - Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegex
```
public void setRegex(String regex)
```
    A regular expression of the patterns that need to be replaced in a managed template job document schema.
    
    Parameters:
    
    regex - A regular expression of the patterns that need to be replaced in a managed template job document schema.
  - getRegex
```
public String getRegex()
```
    A regular expression of the patterns that need to be replaced in a managed template job document schema.
    
    Returns:
    
    A regular expression of the patterns that need to be replaced in a managed template job document schema.
  - withRegex
```
public DocumentParameter withRegex(String regex)
```
    A regular expression of the patterns that need to be replaced in a managed template job document schema.
    
    Parameters:
    
    regex - A regular expression of the patterns that need to be replaced in a managed template job document schema.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExample
```
public void setExample(String example)
```
    An example illustrating a pattern that need to be replaced in a managed template job document schema.
    
    Parameters:
    
    example - An example illustrating a pattern that need to be replaced in a managed template job document schema.
  - getExample
```
public String getExample()
```
    An example illustrating a pattern that need to be replaced in a managed template job document schema.
    
    Returns:
    
    An example illustrating a pattern that need to be replaced in a managed template job document schema.
  - withExample
```
public DocumentParameter withExample(String example)
```
    An example illustrating a pattern that need to be replaced in a managed template job document schema.
    
    Parameters:
    
    example - An example illustrating a pattern that need to be replaced in a managed template job document schema.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOptional
```
public void setOptional(Boolean optional)
```
    Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
    
    Parameters:
    
    optional - Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
  - getOptional
```
public Boolean getOptional()
```
    Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
    
    Returns:
    
    Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
  - withOptional
```
public DocumentParameter withOptional(Boolean optional)
```
    Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
    
    Parameters:
    
    optional - Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isOptional
```
public Boolean isOptional()
```
    Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
    
    Returns:
    
    Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
  - toString
```
public String 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.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.792

Class DocumentParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentParameter

Method Detail

setKey

getKey

withKey

setDescription

getDescription

withDescription

setRegex

getRegex

withRegex

setExample

getExample

withExample

setOptional

getOptional

withOptional

isOptional

toString

equals

hashCode

clone

marshall