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 Details

    • 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

      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:

    • 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 the ResponseExtractionMapping.Builder avoiding the need to create one manually via ResponseExtractionMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to value(ResponseExtractionMapping).

      Parameters:
      value - a consumer that will call methods on ResponseExtractionMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: