Class SdkRequest

  • All Implemented Interfaces:
    SdkPojo

    @Immutable
    public abstract class SdkRequest
    extends Object
    implements SdkPojo
    The base class for all SDK requests.

    Implementations must ensure the class is immutable.

    See Also:
    SdkResponse
    • Constructor Detail

      • SdkRequest

        public SdkRequest()
    • Method Detail

      • overrideConfiguration

        public abstract Optional<? extends RequestOverrideConfiguration> overrideConfiguration()
        Returns:
        The optional client configuration overrides for this request.
      • getValueForField

        public <T> Optional<T> getValueForField​(String fieldName,
                                                Class<T> clazz)
        Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the getValueForField(String, Class) method will again be available.
        Parameters:
        fieldName - The name of the member to be retrieved.
        clazz - The class to cast the returned object to.
        Returns:
        Optional containing the casted return value