CloudFunctionClient

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:
  • 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

Constructors

NewCloudFunctionClient

Creates new instance of CloudFunctionClient

NewCloudFunctionClient() *CloudFunctionClient

Instance methods

AddFilterParams

AddFilterParams method are adds filter parameters (with the same name as they defined) to invocation parameter map.

(c *CloudFunctionClient) AddFilterParams(params *StringValueMap, filter *FilterParams) *StringValueMap

• params: *StringValueMap - invocation parameters.
• filter: *FilterParams - (optional) filter parameters
• returns: *StringValueMap - invocation parameters with added filter parameters.

AddPagingParams

AddPagingParams method are adds paging parameters (skip, take, total) to invocation parameter map.

(c *CloudFunctionClient) AddPagingParams(params *StringValueMap, paging *PagingParams) *StringValueMap

• params: *StringValueMap - invocation parameters.
• paging: *PagingParams - (optional) paging parameters
• returns: *StringValueMap - invocation parameters with added paging parameters.

Call

Calls a Google Function action.

(c *CloudFunctionClient) Call(ctx context.Context, cmd string, correlationId string, args *AnyValueMap) (*http.Response, error)

• ctx: context.Context - operation context.
• cmd: string - an action name to be called.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• params: *AnyValueMap - (optional) action parameters.
• returns: (*http.Response, error) - action result.

Close

Closes component and frees used resources.

(c *CloudFunctionClient) Close(ctx context.Context, correlationId string) error

• ctx: context.Context - operation context.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• returns: error - error close.

Configure

Configures component by passing configuration parameters.

(c *CloudFunctionClient) Configure(ctx context.Context, config *ConfigParams)

• ctx: context.Context - operation context.
• 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.

(c *CloudFunctionClient) Instrument(ctx context.Context, correlationId string, name string) *InstrumentTiming

• ctx: context.Context - operation context.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• name: string - a method name.
• return: *InstrumentTiming - object to end the time measurement.

IsOpen

Checks if the component is opened.

(c *CloudFunctionClient) IsOpen() bool

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

Open

Opens the component.

(c *CloudFunctionClient) Open(ctx context.Context, correlationId string) error

• ctx: context.Context - operation context.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• returns: error - open error.

SetReferences

Sets references to dependent components.

(c *CloudFunctionClient) SetReferences(ctx context.Context, references IReferences)

• ctx: context.Context - operation context.
• references: IReferences - references to locate the component dependencies.

Examples

type MyCloudFunctionClient struct {
	clients.CloudFunctionClient
}

func NewMyCloudFunctionClient() *MyCloudFunctionClient {
	return &MyCloudFunctionClient{
		CloudFunctionClient: *gcpclient.NewCloudFunctionClient(),
	}
}

func (c *MyCloudFunctionClient) GetData(ctx context.Context, correlationId string, id string) MyData {
	timing := c.Instrument(ctx, correlationId, "myclient.get_data")

	response, err := c.Call(ctx, "get_data", correlationId, data.NewAnyValueMapFromTuples("id", dummyId))

	defer timing.EndTiming(ctx, err)
	return rpcclients.HandleHttpResponse[MyData](response, correlationId)
}

...

client := NewMyCloudFunctionClient()
client.Configure(config.NewConfigParamsFromTuples(
	"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",
))
result := client.GetData("123", "1")

See also

• CloudFunction

• CommandableCloudFunctionClient