Class RestConfiguration

    • Method Detail

      • globalSourceConfiguration

        public final SourceConfiguration globalSourceConfiguration()

        Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.

        Returns:
        Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.
      • validationEndpointConfiguration

        public final SourceConfiguration validationEndpointConfiguration()

        Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.

        Returns:
        Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.
      • hasEntityConfigurations

        public final boolean hasEntityConfigurations()
        For responses, this returns true if the service returned a value for the EntityConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • entityConfigurations

        public final Map<String,​EntityConfiguration> entityConfigurations()

        A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEntityConfigurations() method.

        Returns:
        A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)