Helper class used to retrieve Google connection and credential parameters, validate them and compose a GcpConnectionParams value.
Inherits: IConfigurable, IReferenceable
Description
Helper class to retrieve Google connection and credential parameters, validate them and compose a GcpConnectionParams value.
Configuration parameters
- connections:
- uri: full connection uri with specific app and function name
- protocol: connection protocol
- project_id: is your Google Cloud Platform project ID
- region: is the region where your function is deployed
- function_name: is the name of the HTTP function you deployed
- credentials:
- account: the service account name
- auth_token: Google-generated ID token or null if using custom auth
References
- *:credential-store:*:*:1.0 - (optional) credential stores to resolve credentials.
Fields
Instance methods
Configure
Configures a component by passing its configuration parameters.
public
void Configure(ConfigParams config)
- config: ConfigParams - configuration parameters to be set.
ResolveAsync
Resolves connection and credential parameters and generates a single GcpConnectionParams value.
public
Task<GcpConnectionParams> ResolveAsync(string correlationId)
- correlationId: string - (optional) transaction id used to trace execution through the call chain.
- returns: Task<GcpConnectionParams> - receives an GcpConnectionParams value or error.
SetReferences
Sets references to dependent components.
public
void SetReferences(IReferences references)
- references: IReferences - references to locate the component’s dependencies.
Examples
var config = GcpConnectionParams.FromTuples(
"connection.uri", "http://east-my_test_project.cloudfunctions.net/myfunction",
"connection.protocol", "http",
"connection.region", "east",
"connection.function", "myfunction",
"connection.project_id", "my_test_project",
"credential.auth_token", "1234"
);
var connectionResolver = new GcpConnectionResolver();
connectionResolver.Configure(config);
connectionResolver.SetReferences(references);
var connectionParams = await connectionResolver.ResolveAsync("123");