java.lang.Object
- software.amazon.awssdk.services.iot.model.DocumentParameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>
```
@Generated("software.amazon.awssdk:codegen")
public final class DocumentParameter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>
```
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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DocumentParameter.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DocumentParameter.Builder`	`builder()`
`String`	`description()`	Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`example()`	An example illustrating a pattern that need to be replaced in a managed template job document schema.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`key()`	Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
`Boolean`	`optional()`	Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
`String`	`regex()`	A regular expression of the patterns that need to be replaced in a managed template job document schema.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DocumentParameter.Builder>`	`serializableBuilderClass()`
`DocumentParameter.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - key
```
public final String key()
```
    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.
  - description
```
public final String description()
```
    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.
  - regex
```
public final String regex()
```
    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.
  - example
```
public final String example()
```
    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.
  - optional
```
public final Boolean optional()
```
    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.
  - toBuilder
```
public DocumentParameter.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>
  - builder
```
public static DocumentParameter.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentParameter.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DocumentParameter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

key

description

regex

example

optional

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields