Class RegionalClientBase
An abstract class for a regional service client.
Inheritance
RegionalClientBase
Assembly: OCI.DotNetSDK.Common.dll
Syntax
public abstract class RegionalClientBase : ClientBase, IDisposable
Constructors
RegionalClientBase(IBasicAuthenticationDetailsProvider)
Declaration
public RegionalClientBase(IBasicAuthenticationDetailsProvider authProvider)
Parameters
RegionalClientBase(IBasicAuthenticationDetailsProvider, ClientConfiguration)
Declaration
public RegionalClientBase(IBasicAuthenticationDetailsProvider authProvider, ClientConfiguration clientConfiguration)
Parameters
RegionalClientBase(IBasicAuthenticationDetailsProvider, ClientConfiguration, RequestSigner)
Declaration
public RegionalClientBase(IBasicAuthenticationDetailsProvider authProvider, ClientConfiguration clientConfiguration, RequestSigner requestSigner)
Parameters
RegionalClientBase(IBasicAuthenticationDetailsProvider, RequestSigner)
Declaration
public RegionalClientBase(IBasicAuthenticationDetailsProvider authProvider, RequestSigner requestSigner)
Parameters
Fields
logger
Declaration
protected static Logger logger
Field Value
Methods
PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated
if the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter
in the endpoint will be ignored and left blank.
Declaration
public static Uri PopulateServiceParametersInEndpointTemplate(RestClient client, Dictionary<string, object> requiredParametersDictionary)
Parameters
| Type |
Name |
Description |
| RestClient |
client |
|
| Dictionary<string, object> |
requiredParametersDictionary |
Dictionary of parameter name as key and value set in request path or query parameter as value
|
Returns
SetRegion(Region)
Set endpoint through region.
Declaration
public void SetRegion(Region region)
Parameters
| Type |
Name |
Description |
| Region |
region |
The region used to set endpoint.
|
SetRegion(string)
Set endpoint through regionId.
Declaration
public void SetRegion(string regionId)
Parameters
| Type |
Name |
Description |
| string |
regionId |
|
UseRealmSpecificEndpointTemplate(bool)
Declaration
public void UseRealmSpecificEndpointTemplate(bool IsRealmSpecificEndpointTemplateEnabled)
Parameters
| Type |
Name |
Description |
| bool |
IsRealmSpecificEndpointTemplateEnabled |
|
parseEndpointForParameters(string)
This function extracts the parameters in the parameterized endpoint template. E.g. if endpoint is https://foo{param1+Dot}.bar{query1}.ocifake
then this function returns a string array ["{param1+Dot}", "{query1}"]
Declaration
public static string[] parseEndpointForParameters(string endpoint)
Parameters
| Type |
Name |
Description |
| string |
endpoint |
Parameterized endpoint template
|
Returns
| Type |
Description |
| string[] |
string array containing name of parameters
|
Implements