Interface RestConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RestConfiguration.Builder,RestConfiguration>, SdkBuilder<RestConfiguration.Builder,RestConfiguration>, SdkPojo
Enclosing class:
RestConfiguration
@Mutable @NotThreadSafe public static interface RestConfiguration.Builder extends SdkPojo, CopyableBuilder<RestConfiguration.Builder,RestConfiguration>

  • Method Details

    • globalSourceConfiguration

      RestConfiguration.Builder globalSourceConfiguration(SourceConfiguration globalSourceConfiguration)

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

      Parameters:
      globalSourceConfiguration - Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalSourceConfiguration

      default RestConfiguration.Builder globalSourceConfiguration(Consumer<SourceConfiguration.Builder> globalSourceConfiguration)

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

      This is a convenience method that creates an instance of the SourceConfiguration.Builder avoiding the need to create one manually via SourceConfiguration.builder().

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

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

    • validationEndpointConfiguration

      RestConfiguration.Builder validationEndpointConfiguration(SourceConfiguration validationEndpointConfiguration)

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

      Parameters:
      validationEndpointConfiguration - Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validationEndpointConfiguration

      default RestConfiguration.Builder validationEndpointConfiguration(Consumer<SourceConfiguration.Builder> validationEndpointConfiguration)

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

      This is a convenience method that creates an instance of the SourceConfiguration.Builder avoiding the need to create one manually via SourceConfiguration.builder().

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

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

    • entityConfigurations

      RestConfiguration.Builder entityConfigurations(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.