com.gluonhq.cloudlink.client.data

Class RemoteFunctionBuilder

java.lang.Object

com.gluonhq.cloudlink.client.data.RemoteFunctionBuilder

public class RemoteFunctionBuilder
extends java.lang.Object

A utility class for building RemoteFunction instances.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteFunctionBuilder(java.lang.String functionName) Default constructor.

Method Summary

Modifier and Type	Method and Description
RemoteFunction	build() Make an instance of RemoteFunction based on the properties set on this builder.
static RemoteFunctionBuilder	create(java.lang.String functionName) Create a new instance of RemoteFunctionBuilder that can be used to build instances of RemoteFunction.
RemoteFunctionBuilder	param(java.lang.String key, java.lang.String value) Adds a function parameter with the specified key and value.
RemoteFunctionBuilder	rawBody(byte[] rawBody) Defines the bytes that are sent as the raw body when executing the request to the remote function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteFunctionBuilder

protected RemoteFunctionBuilder(java.lang.String functionName)

Default constructor.

Parameters:

functionName - the name of the configured remote function to call

Method Detail

create

public static RemoteFunctionBuilder create(java.lang.String functionName)

Create a new instance of RemoteFunctionBuilder that can be used to build instances of RemoteFunction.

Parameters:

functionName - the name of the configured remote function to call

Returns:

a new instance of RemoteFunctionBuilder

param

public RemoteFunctionBuilder param(java.lang.String key,
                                   java.lang.String value)

Adds a function parameter with the specified key and value. If a parameter with the specified key was already provided before, the old value will be overwritten with the specified value.

Parameters:

key - the name of the parameter

value - the value of the parameter

Returns:

A reference to this builder.

rawBody

public RemoteFunctionBuilder rawBody(byte[] rawBody)

Defines the bytes that are sent as the raw body when executing the request to the remote function.

Parameters:

rawBody - the raw bytes to sent as the raw body for the remote function

Returns:

A reference to this builder.

build

public RemoteFunction build()

Make an instance of RemoteFunction based on the properties set on this builder.

Returns:

The constructed RemoteFunction instance.