CloudFunctionClient

Implements: IOpenable, IConfigurable, IReferenceable

Description

When making calls “cmd” parameter determines which what action shall be called, while other parameters are passed to the action itself.

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
• options:
  • retries: number of retries (default: 3)
  • connect_timeout: connection timeout in milliseconds (default: 10 sec)
  • timeout: invocation timeout in milliseconds (default: 10 sec)
• credentials:
  • account: the service account name
  • auth_token: Google-generated ID token, if use custom authorization provide empty string

References

• *:logger:*:*:1.0 - (optional) ILogger components to pass log messages.
• *:counters:*:*:1.0 - (optional) ICounters components to pass collected measurements.
• *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connections.
• *:credential-store:*:*:1.0 - (optional) Credential stores to resolve credentials.

Fields

Instance methods

call

Calls a Google Function action.

_call(cmd: str, correlation_id: Optional[str], params: dict = None): Optional[dict]

• cmd: str - an action name to be called.
• correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.
• params: dict - (optional) action parameters.
• returns: Optional[dict] - action result.

close

Closes component and frees used resources.

close(correlation_id: Optional[str])

• correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.

configure

Configures component by passing configuration parameters.

configure(config: ConfigParams)

• config: ConfigParams - configuration parameters to be set.

_instrument

Adds instrumentation to log calls and measure call time. It returns a CounterTiming object that is used to end the time measurement.

_instrument(correlation_id: Optional[str], name: str): InstrumentTiming

• correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.
• name: str - a method name.
• return: InstrumentTiming - object to end the time measurement.

_invoke

Performs Google Function invocation.

_invoke(cmd: str, correlation_id: Optional[str], args: dict = None): Optional[dict]

• cmd: str - an action name to be called.
• correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.
• args: dict - action arguments
• returns: Optional[dict] - action result.

isOpen

Checks if the component is opened.

isOpen(): bool

• returns: bool - true if the component has been opened and false otherwise.

open

Opens the component.

open(correlation_id: Optional[str])

• correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.

set_references

Sets references to dependent components.

set_references(references: IReferences)

• references: IReferences - references to locate the component dependencies.

Examples

class MyCloudFunctionClient(CloudFunctionClient, IMyClient):
    
    def get_data(self, correlation_id, id) -> MyData:
        timing = self._instrument(correlation_id, 'myclient.get_data')
        result = self._call("get_data", correlation_id, {'id': id})
        data = MyData(**result)
        timing.end_timing()
        return data

client = MyCloudFunctionClient()

client.configure(ConfigParams.from_tuples(
    'connection.uri", "http://region-id.cloudfunctions.net/myfunction',
    'connection.protocol', 'http',
    'connection.region', 'region',
    'connection.function', 'myfunction',
    'connection.project_id', 'id',
    'credential.auth_token', 'XXX',
))

client.open("123")
result = client.get_data("123", "1")
...

See also

• CloudFunction

• CommandableCloudFunctionClient