Interface SourceConfiguration.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<SourceConfiguration.Builder,SourceConfiguration>,SdkBuilder<SourceConfiguration.Builder,SourceConfiguration>,SdkPojo
- Enclosing class:
- SourceConfiguration
@Mutable @NotThreadSafe public static interface SourceConfiguration.Builder extends SdkPojo, CopyableBuilder<SourceConfiguration.Builder,SourceConfiguration>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default SourceConfiguration.BuilderpaginationConfiguration(Consumer<PaginationConfiguration.Builder> paginationConfiguration)Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.SourceConfiguration.BuilderpaginationConfiguration(PaginationConfiguration paginationConfiguration)Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.SourceConfiguration.BuilderrequestMethod(String requestMethod)The HTTP method to use for requests to this endpoint, such as GET, POST.SourceConfiguration.BuilderrequestMethod(HTTPMethod requestMethod)The HTTP method to use for requests to this endpoint, such as GET, POST.SourceConfiguration.BuilderrequestParameters(Collection<ConnectorProperty> requestParameters)Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.SourceConfiguration.BuilderrequestParameters(Consumer<ConnectorProperty.Builder>... requestParameters)Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.SourceConfiguration.BuilderrequestParameters(ConnectorProperty... requestParameters)Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.SourceConfiguration.BuilderrequestPath(String requestPath)The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.default SourceConfiguration.BuilderresponseConfiguration(Consumer<ResponseConfiguration.Builder> responseConfiguration)Configuration that defines how to parse and extract data from API responses, including success and error handling.SourceConfiguration.BuilderresponseConfiguration(ResponseConfiguration responseConfiguration)Configuration that defines how to parse and extract data from API responses, including success and error handling.-
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
-
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.
-
requestParameters
SourceConfiguration.Builder requestParameters(Consumer<ConnectorProperty.Builder>... requestParameters)
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
This is a convenience method that creates an instance of theConnectorProperty.Builderavoiding the need to create one manually viaConnectorProperty.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#requestParameters(List.) - Parameters:
requestParameters- a consumer that will call methods onConnectorProperty.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#requestParameters(java.util.Collection)
-
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.
-
responseConfiguration
default SourceConfiguration.Builder responseConfiguration(Consumer<ResponseConfiguration.Builder> responseConfiguration)
Configuration that defines how to parse and extract data from API responses, including success and error handling.
This is a convenience method that creates an instance of theResponseConfiguration.Builderavoiding the need to create one manually viaResponseConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toresponseConfiguration(ResponseConfiguration).- Parameters:
responseConfiguration- a consumer that will call methods onResponseConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
responseConfiguration(ResponseConfiguration)
-
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.
-
paginationConfiguration
default SourceConfiguration.Builder paginationConfiguration(Consumer<PaginationConfiguration.Builder> paginationConfiguration)
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
This is a convenience method that creates an instance of thePaginationConfiguration.Builderavoiding the need to create one manually viaPaginationConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topaginationConfiguration(PaginationConfiguration).- Parameters:
paginationConfiguration- a consumer that will call methods onPaginationConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
paginationConfiguration(PaginationConfiguration)
-
-