Class ServiceType
Namespace: Oracle.NoSQL.SDK
Assembly: Oracle.NoSQL.SDK.dll
Syntax
public sealed class ServiceType : Enum
Remarks
Currently there are 3 supported types of service: Oracle NoSQL Cloud Service, On-premise KVStore and Cloud Simulator. The service type is heavily linked to an authorization type used by the service indicated by AuthorizationProvider property. If specifying both ServiceType and AuthorizationProvider, they must be compatible, e.g. you may not specify ServiceType as Cloud and using KVStoreAuthorizationProvider.
For service types Cloud and KVStore is is possible to specify a custom authorization provider as an instance of a class implementing IAuthorizationProvider interface.
Although it is advisable to specify the service type as ServiceType when creating NoSQLClient instance, the driver may also be able to determine the service type from the authorization type as follows:
- If AuthorizationProvider is not set, then the service type is Cloud if Region is set, otherwise it is CloudSim.
- If AuthorizationProvider is an instance of IAMAuthorizationProvider or its subclass, the service type is Cloud.
- If AuthorizationProvider is an instance of KVStoreAuthorizationProvider or its subclass, the service type is KVStore.
- If none of the above, an ArgumentException is thrown.
Fields
Name | Description |
---|---|
Cloud | Oracle NoSQL Cloud Service. Authorization is managed by IAM. You must set AuthorizationProvider to an instance of IAMAuthorizationProvider unless using OCI configuration file with the specified region (see NoSQLClient(NoSQLConfig)), in which case the driver will instantiate a default instance of IAMAuthorizationProvider. |
CloudSim | Cloud Simulator. No authorization required. |
KVStore | On-Premise Oracle NoSQL Database. This includes both secure and non-secure stores. For secure store, the authorization is required and AuthorizationProvider must be set to an instance of KVStoreAuthorizationProvider. For non-secure store, authorization is not required but you must set, ServiceType to KVStore. |
Unspecified | The service type is not specified. This is the default value if you don't specify ServiceType, in which case the driver will try to determine the service type as described. If the service type cannot be determined, an ArgumentException is thrown. |
value__ |