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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<ExtractedParameter.Builder,ExtractedParameter>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.