Class DocumentParameter
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DocumentParameter.Builder
builder()
final String
Description of the map field containing the patterns that need to be replaced in a managed template job document schema.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
example()
An example illustrating a pattern that need to be replaced in a managed template job document schema.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
key()
Key of the map field containing the patterns that need to be replaced in a managed template job document schema.final Boolean
optional()
Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.final String
regex()
A regular expression of the patterns that need to be replaced in a managed template job document schema.static Class
<? extends DocumentParameter.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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<DocumentParameter.Builder,
DocumentParameter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-