Class BaseQldbDriverBuilder<TBuilder, TDriver>
Base builder object for creating QLDB driver objects, allowing for configuration of the parameters of construction.
Inheritance
Namespace: Amazon.QLDB.Driver
Assembly: Amazon.QLDB.Driver.dll
Syntax
public abstract class BaseQldbDriverBuilder<TBuilder, TDriver> : object where TBuilder : BaseQldbDriverBuilder<TBuilder, TDriver> where TDriver : IQldbDriver
Type Parameters
Name | Description |
---|---|
TBuilder | The builder type. |
TDriver | The driver type. |
Methods
| Improve this Doc View SourceBuild()
Build a driver instance using the current configuration set with the builder.
Declaration
public TDriver Build()
Returns
Type | Description |
---|---|
TDriver | A newly created driver. |
WithAWSCredentials(AWSCredentials)
Specify the credentials that should be used for the driver's sessions.
Declaration
public TBuilder WithAWSCredentials(AWSCredentials credentials)
Parameters
Type | Name | Description |
---|---|---|
AWSCredentials | credentials | The credentials to create a driver with. |
Returns
Type | Description |
---|---|
TBuilder | This builder object. |
WithLedger(String)
Specify the ledger that should be used for the driver's sessions.
Declaration
public TBuilder WithLedger(string ledgerName)
Parameters
Type | Name | Description |
---|---|---|
System.String | ledgerName | The name of the ledger to create a driver with. |
Returns
Type | Description |
---|---|
TBuilder | This builder object. |
WithLogger(ILogger)
Specify the logger that should be used for the driver's sessions.
Declaration
public TBuilder WithLogger(ILogger logger)
Parameters
Type | Name | Description |
---|---|---|
ILogger | logger | The logger to create a driver with. |
Returns
Type | Description |
---|---|
TBuilder | This builder object. |
WithQLDBSessionConfig(AmazonQLDBSessionConfig)
Specify the configuration that should be used for the driver's sessions.
Declaration
public TBuilder WithQLDBSessionConfig(AmazonQLDBSessionConfig sessionConfig)
Parameters
Type | Name | Description |
---|---|---|
AmazonQLDBSessionConfig | sessionConfig | The configuration to create a driver with. |
Returns
Type | Description |
---|---|
TBuilder | This builder object. |
WithRetryLimit(Int32)
Specify the retry limit that any convenience execute methods provided by sessions created from the driver will attempt.
Declaration
public TBuilder WithRetryLimit(int retryLimit)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | retryLimit | The number of retry attempts to be made by the session. |
Returns
Type | Description |
---|---|
TBuilder | This builder object. |