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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description RestConfiguration.BuilderentityConfigurations(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.default RestConfiguration.BuilderglobalSourceConfiguration(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.RestConfiguration.BuilderglobalSourceConfiguration(SourceConfiguration globalSourceConfiguration)Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.default RestConfiguration.BuildervalidationEndpointConfiguration(Consumer<SourceConfiguration.Builder> validationEndpointConfiguration)Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.RestConfiguration.BuildervalidationEndpointConfiguration(SourceConfiguration validationEndpointConfiguration)Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
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 theSourceConfiguration.Builderavoiding the need to create one manually viaSourceConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toglobalSourceConfiguration(SourceConfiguration).- Parameters:
globalSourceConfiguration- a consumer that will call methods onSourceConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
globalSourceConfiguration(SourceConfiguration)
-
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 theSourceConfiguration.Builderavoiding the need to create one manually viaSourceConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovalidationEndpointConfiguration(SourceConfiguration).- Parameters:
validationEndpointConfiguration- a consumer that will call methods onSourceConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
validationEndpointConfiguration(SourceConfiguration)
-
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.
-
-