Interface ExtractedParameter.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ExtractedParameter.Builder,ExtractedParameter>,SdkBuilder<ExtractedParameter.Builder,ExtractedParameter>,SdkPojo
- Enclosing class:
- ExtractedParameter
@Mutable @NotThreadSafe public static interface ExtractedParameter.Builder extends SdkPojo, CopyableBuilder<ExtractedParameter.Builder,ExtractedParameter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ExtractedParameter.BuilderdefaultValue(String defaultValue)The default value to use if the parameter cannot be extracted from the response.ExtractedParameter.Builderkey(String key)The parameter key name that will be used in subsequent requests.ExtractedParameter.BuilderpropertyLocation(String propertyLocation)Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.ExtractedParameter.BuilderpropertyLocation(PropertyLocation propertyLocation)Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.default ExtractedParameter.Buildervalue(Consumer<ResponseExtractionMapping.Builder> value)The JSON path or extraction mapping that defines how to extract the parameter value from API responses.ExtractedParameter.Buildervalue(ResponseExtractionMapping value)The JSON path or extraction mapping that defines how to extract the parameter value from API responses.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
key
ExtractedParameter.Builder key(String key)
The parameter key name that will be used in subsequent requests.
- Parameters:
key- The parameter key name that will be used in subsequent requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultValue
ExtractedParameter.Builder defaultValue(String defaultValue)
The default value to use if the parameter cannot be extracted from the response.
- Parameters:
defaultValue- The default value to use if the parameter cannot be extracted from the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
propertyLocation
ExtractedParameter.Builder propertyLocation(String propertyLocation)
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
- Parameters:
propertyLocation- Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PropertyLocation,PropertyLocation
-
propertyLocation
ExtractedParameter.Builder propertyLocation(PropertyLocation propertyLocation)
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
- Parameters:
propertyLocation- Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PropertyLocation,PropertyLocation
-
value
ExtractedParameter.Builder value(ResponseExtractionMapping value)
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
- Parameters:
value- The JSON path or extraction mapping that defines how to extract the parameter value from API responses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
value
default ExtractedParameter.Builder value(Consumer<ResponseExtractionMapping.Builder> value)
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
This is a convenience method that creates an instance of theResponseExtractionMapping.Builderavoiding the need to create one manually viaResponseExtractionMapping.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovalue(ResponseExtractionMapping).- Parameters:
value- a consumer that will call methods onResponseExtractionMapping.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
value(ResponseExtractionMapping)
-
-