Package software.amazon.awssdk.services.glue.model

Class ExtractedParameter

java.lang.Object

software.amazon.awssdk.services.glue.model.ExtractedParameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExtractedParameter.Builder,ExtractedParameter>

@Generated("software.amazon.awssdk:codegen")
public final class ExtractedParameter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExtractedParameter.Builder,ExtractedParameter>

Parameter extraction configuration that defines how to extract and map values from API responses to request parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExtractedParameter.Builder

Method Summary

Modifier and Type	Method	Description
static ExtractedParameter.Builder	builder()
String	defaultValue()	The default value to use if the parameter cannot be extracted from the response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The parameter key name that will be used in subsequent requests.
PropertyLocation	propertyLocation()	Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
String	propertyLocationAsString()	Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ExtractedParameter.Builder>	serializableBuilderClass()
ExtractedParameter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ResponseExtractionMapping	value()	The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

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()

The parameter key name that will be used in subsequent requests.

Returns:

The parameter key name that will be used in subsequent requests.

defaultValue

public final String defaultValue()

The default value to use if the parameter cannot be extracted from the response.

Returns:

The default value to use if the parameter cannot be extracted from the response.

propertyLocation

public final PropertyLocation propertyLocation()

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

If the service returns an enum value that is not available in the current SDK version, propertyLocation will return PropertyLocation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propertyLocationAsString().

Returns:

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

See Also:

PropertyLocation

propertyLocationAsString

public final String propertyLocationAsString()

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

If the service returns an enum value that is not available in the current SDK version, propertyLocation will return PropertyLocation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propertyLocationAsString().

Returns:

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

See Also:

PropertyLocation

value

public final ResponseExtractionMapping value()

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

Returns:

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

toBuilder

public ExtractedParameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExtractedParameter.Builder,ExtractedParameter>

builder

public static ExtractedParameter.Builder builder()

serializableBuilderClass

public static Class<? extends ExtractedParameter.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo