Class SourceConfiguration

    • Method Detail

      • requestMethod

        public final HTTPMethod requestMethod()

        The HTTP method to use for requests to this endpoint, such as GET, POST.

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

        Returns:
        The HTTP method to use for requests to this endpoint, such as GET, POST.
        See Also:
        HTTPMethod
      • requestMethodAsString

        public final String requestMethodAsString()

        The HTTP method to use for requests to this endpoint, such as GET, POST.

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

        Returns:
        The HTTP method to use for requests to this endpoint, such as GET, POST.
        See Also:
        HTTPMethod
      • requestPath

        public final String requestPath()

        The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

        Returns:
        The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
      • hasRequestParameters

        public final boolean hasRequestParameters()
        For responses, this returns true if the service returned a value for the RequestParameters 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.
      • requestParameters

        public final List<ConnectorProperty> requestParameters()

        Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

        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 hasRequestParameters() method.

        Returns:
        Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
      • responseConfiguration

        public final ResponseConfiguration responseConfiguration()

        Configuration that defines how to parse and extract data from API responses, including success and error handling.

        Returns:
        Configuration that defines how to parse and extract data from API responses, including success and error handling.
      • paginationConfiguration

        public final PaginationConfiguration paginationConfiguration()

        Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

        Returns:
        Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
      • 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)