Interface SourceConfiguration.Builder

    • Method Detail

      • requestMethod

        SourceConfiguration.Builder requestMethod​(String requestMethod)

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

        Parameters:
        requestMethod - The HTTP method to use for requests to this endpoint, such as GET, POST.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HTTPMethod, HTTPMethod
      • requestMethod

        SourceConfiguration.Builder requestMethod​(HTTPMethod requestMethod)

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

        Parameters:
        requestMethod - The HTTP method to use for requests to this endpoint, such as GET, POST.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HTTPMethod, HTTPMethod
      • requestPath

        SourceConfiguration.Builder requestPath​(String requestPath)

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

        Parameters:
        requestPath - The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • requestParameters

        SourceConfiguration.Builder requestParameters​(Collection<ConnectorProperty> requestParameters)

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

        Parameters:
        requestParameters - Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • requestParameters

        SourceConfiguration.Builder requestParameters​(ConnectorProperty... requestParameters)

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

        Parameters:
        requestParameters - Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • responseConfiguration

        SourceConfiguration.Builder responseConfiguration​(ResponseConfiguration responseConfiguration)

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

        Parameters:
        responseConfiguration - Configuration that defines how to parse and extract data from API responses, including success and error handling.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • paginationConfiguration

        SourceConfiguration.Builder paginationConfiguration​(PaginationConfiguration paginationConfiguration)

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

        Parameters:
        paginationConfiguration - Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
        Returns:
        Returns a reference to this object so that method calls can be chained together.