com.baidubce.services.cfc

Class CfcClient

java.lang.Object

com.baidubce.AbstractBceClient

com.baidubce.services.cfc.CfcClient

public class CfcClient
extends AbstractBceClient

Provides the client for accessing the Cloud Function Compute Service.

Field Summary

Fields inherited from class com.baidubce.AbstractBceClient

config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX

Constructor Summary

Constructors

Constructor and Description
CfcClient() Constructs a new client to invoke service methods on CFC
CfcClient(BceClientConfiguration clientConfiguration) Constructs a new client using the client configuration to access CFC services.

Method Summary

Modifier and Type	Method and Description
CreateAliasResponse	createAlias(CreateAliasRequest request) Create function alias
CreateAliasResponse	createAlias(String functionName, String functionVersion, String name, String description) Create function alias
CreateFunctionResponse	createFunction(CreateFunctionRequest request) Create a new function
CreateTriggerResponse	createTrigger(CreateTriggerRequest request) Create trigger
CreateTriggerResponse	createTrigger(String target, String source, Map<String,String> data) Create trigger
DeleteAliasResponse	deleteAlias(DeleteAliasRequest request) Delete function alias
DeleteAliasResponse	deleteAlias(String functionName, String aliasName) Delete function alias
DeleteFunctionResponse	deleteFunction(DeleteFunctionRequest request) Delete function
DeleteFunctionResponse	deleteFunction(String functionName, String qualifier) Delete function
DeleteTriggerResponse	deleteTrigger(DeleteTriggerRequest request) Delete trigger
DeleteTriggerResponse	deleteTrigger(String target, String source, String relationId) Delete trigger
GetAliasResponse	getAlias(GetAliasRequest request) Get function alias
GetAliasResponse	getAlias(String aliasName, String functionName) Get function alias
GetFunctionResponse	getFunction(GetFunctionRequest request) Get function information
GetFunctionResponse	getFunction(String functionName, String qualifier) Get function information
GetFunctionConfigurationResponse	getFunctionConfiguration(GetFunctionConfigurationRequest request) Get function configuration
GetFunctionConfigurationResponse	getFunctionConfiguration(String functionName, String qualifier) Get function configuration
InvokeResponse	invoke(InvokeRequest request) Invoke function
InvokeResponse	invoke(String functionName, String invocationType, String logType, String qualifier, Map<String,String> payload) Invoke function
ListAliasesResponse	listAliases(ListAliasesRequest request) Get function alias list
ListAliasesResponse	listAliases(String functionName, String functionVersion, Integer marker, Integer maxItems)
ListFunctionsResponse	listFunctions(ListFunctionsRequest request) Get user function list
ListFunctionsResponse	listFunctions(String functionVersion, Integer marker, Integer maxItems) Get user function list
ListTriggersResponse	listTriggers(ListTriggersRequest request) Get trigger list
ListTriggersResponse	listTriggers(String functionBrn) Get trigger list
ListVersionsByFunctionResponse	listVersionsByFunction(ListVersionsByFunctionRequest request) Get function version list
ListVersionsByFunctionResponse	listVersionsByFunction(String functionName, Integer marker, Integer maxItems) Get function version list
PublishVersionResponse	publishVersion(PublishVersionRequest request) Publish function
PublishVersionResponse	publishVersion(String functionName, String description, String codeSha256)
UpdateAliasResponse	updateAlias(String functionName, String functionVersion, String aliasName, String description) Update alias
UpdateAliasResponse	updateAlias(UpdateAliasRequest request) Update function alias
UpdateFunctionCodeResponse	updateFunctionCode(UpdateFunctionCodeRequest request) Update function code
UpdateFunctionConfigurationResponse	updateFunctionConfiguration(UpdateFunctionConfigurationRequest request) Update function configuration
UpdateTriggerResponse	updateTrigger(String relationId, String target, String source, Map<String,String> data) Update trigger
UpdateTriggerResponse	updateTrigger(UpdateTriggerRequest request) Update trigger

Methods inherited from class com.baidubce.AbstractBceClient

computeServiceId, getClient, getEndpoint, getServiceId, invokeHttpClient, isRegionSupported, setClient, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

CfcClient

public CfcClient()

Constructs a new client to invoke service methods on CFC

CfcClient

public CfcClient(BceClientConfiguration clientConfiguration)

Constructs a new client using the client configuration to access CFC services.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Document services (e.g. proxy settings, retry counts, etc).

Method Detail

createFunction

public CreateFunctionResponse createFunction(CreateFunctionRequest request)

Create a new function

Parameters:

request - The request containing user-defined function information

Returns:

Result of the createFunction operation returned by the service

listFunctions

public ListFunctionsResponse listFunctions(String functionVersion,
                                           Integer marker,
                                           Integer maxItems)

Get user function list

Parameters:

functionVersion - (Optional) Specify the version of the function. If no function returns the $LATEST version of the function, the optional valid value ALL will return all versions, including $LATEST

marker - (Optional) marker

maxItems - (Optional) 1-10000

Returns:

listFunctions

public ListFunctionsResponse listFunctions(ListFunctionsRequest request)

Get user function list

Parameters:

request -

Returns:

User function list

getFunction

public GetFunctionResponse getFunction(String functionName,
                                       String qualifier)

Get function information

Parameters:

functionName - (Required) Function Name You can specify a function name (for example, Thumbnail), or you can specify the function's BRN resource name (for example, brn:bce:cfc:bj:account-id: function:thumbnail:$LATEST). CFC also allows you to specify a partial BRN (for example, account-id:Thumbnail). Note that the BRN length is limited to 1-170. If only the function name is specified, the length is limited to 64 characters.

qualifier - (optional) Function Alias Use this optional parameter to specify a function version or alias. If you specify a function version, the API will use the qualified function BRN to request and return information about the specific CFC function version. If you specify an alias, the API returns information about the version of the function pointed to by the alias. If you don't provide this parameter, the API returns information about the CFC function $LATEST

Returns:

getFunction

public GetFunctionResponse getFunction(GetFunctionRequest request)

Get function information

Parameters:

request -

Returns:

GetFunctionResponse User function information

deleteFunction

public DeleteFunctionResponse deleteFunction(String functionName,
                                             String qualifier)

Delete function

Parameters:

functionName - (Required) Function name

qualifier - (optional) Function alias

Returns:

deleteFunction

public DeleteFunctionResponse deleteFunction(DeleteFunctionRequest request)

Delete function

Parameters:

request -

Returns:

updateFunctionCode

public UpdateFunctionCodeResponse updateFunctionCode(UpdateFunctionCodeRequest request)

Update function code

Parameters:

request -

Returns:

Function information

getFunctionConfiguration

public GetFunctionConfigurationResponse getFunctionConfiguration(String functionName,
                                                                 String qualifier)

Get function configuration

Parameters:

functionName - (Required) Function name

qualifier - (Optional) Function alias

Returns:

getFunctionConfiguration

public GetFunctionConfigurationResponse getFunctionConfiguration(GetFunctionConfigurationRequest request)

Get function configuration

Parameters:

request -

Returns:

function information

updateFunctionConfiguration

public UpdateFunctionConfigurationResponse updateFunctionConfiguration(UpdateFunctionConfigurationRequest request)

Update function configuration

Parameters:

request -

Returns:

Function information

listVersionsByFunction

public ListVersionsByFunctionResponse listVersionsByFunction(String functionName,
                                                             Integer marker,
                                                             Integer maxItems)

Get function version list

Parameters:

functionName - (Required) Function name

marker - (Optional) Function marker

maxItems - (Optional) MaxItems 1-10000

Returns:

listVersionsByFunction

public ListVersionsByFunctionResponse listVersionsByFunction(ListVersionsByFunctionRequest request)

Get function version list

Parameters:

request -

Returns:

publishVersion

public PublishVersionResponse publishVersion(String functionName,
                                             String description,
                                             String codeSha256)

publishVersion

public PublishVersionResponse publishVersion(PublishVersionRequest request)

Publish function

Parameters:

request -

Returns:

listAliases

public ListAliasesResponse listAliases(String functionName,
                                       String functionVersion,
                                       Integer marker,
                                       Integer maxItems)

listAliases

public ListAliasesResponse listAliases(ListAliasesRequest request)

Get function alias list

Parameters:

request -

Returns:

createAlias

public CreateAliasResponse createAlias(String functionName,
                                       String functionVersion,
                                       String name,
                                       String description)

Create function alias

Parameters:

functionName - Function name

functionVersion - Function version

name - Alias, uppercase and lowercase letters, numbers, and -_/. special characters, must start with a letter and be limited to 64 characters in length

description - Alias description

Returns:

Alias information

createAlias

public CreateAliasResponse createAlias(CreateAliasRequest request)

Create function alias

Parameters:

request -

Returns:

Alias information

getAlias

public GetAliasResponse getAlias(String aliasName,
                                 String functionName)

Get function alias

Parameters:

aliasName - Alias name

functionName - Function name

Returns:

getAlias

public GetAliasResponse getAlias(GetAliasRequest request)

Get function alias

Parameters:

request -

Returns:

updateAlias

public UpdateAliasResponse updateAlias(String functionName,
                                       String functionVersion,
                                       String aliasName,
                                       String description)

Update alias

Parameters:

functionName - Function name

functionVersion - Function version

aliasName - Alias name

description - Alias description

Returns:

updateAlias

public UpdateAliasResponse updateAlias(UpdateAliasRequest request)

Update function alias

Parameters:

request -

Returns:

deleteAlias

public DeleteAliasResponse deleteAlias(String functionName,
                                       String aliasName)

Delete function alias

Parameters:

functionName - Function name

aliasName - Alias name

Returns:

deleteAlias

public DeleteAliasResponse deleteAlias(DeleteAliasRequest request)

Delete function alias

Parameters:

request -

Returns:

listTriggers

public ListTriggersResponse listTriggers(String functionBrn)

Get trigger list

Parameters:

functionBrn - Function BRN

Returns:

listTriggers

public ListTriggersResponse listTriggers(ListTriggersRequest request)

Get trigger list

Parameters:

request -

Returns:

createTrigger

public CreateTriggerResponse createTrigger(String target,
                                           String source,
                                           Map<String,String> data)

Create trigger

Parameters:

target - Function BRN

source - Trigger source

data - Trigger parameter configuration

Returns:

createTrigger

public CreateTriggerResponse createTrigger(CreateTriggerRequest request)

Create trigger

Parameters:

request -

Returns:

updateTrigger

public UpdateTriggerResponse updateTrigger(String relationId,
                                           String target,
                                           String source,
                                           Map<String,String> data)

Update trigger

Parameters:

relationId - Trigger ID

target - Function BRN

source - Trigger source

data - Trigger parameter configuration

Returns:

updateTrigger

public UpdateTriggerResponse updateTrigger(UpdateTriggerRequest request)

Update trigger

Parameters:

request -

Returns:

deleteTrigger

public DeleteTriggerResponse deleteTrigger(String target,
                                           String source,
                                           String relationId)

Delete trigger

Parameters:

target - Function BRN

source - Trigger source

relationId - Trigger ID

Returns:

deleteTrigger

public DeleteTriggerResponse deleteTrigger(DeleteTriggerRequest request)

Delete trigger

Parameters:

request -

Returns:

invoke

public InvokeResponse invoke(String functionName,
                             String invocationType,
                             String logType,
                             String qualifier,
                             Map<String,String> payload)

Invoke function

Parameters:

functionName - Function name or function BRN

invocationType - Call mode Event (asynchronous call) returns 202/RequestResponse (sync return) / DryRun (test function). Default ResauestResponse

logType - Log type Tail / None You can set this optional parameter to Tail, provided the InvocationType parameter must be RequestResponse

qualifier - Function version or function alias

payload -

Returns:

invoke

public InvokeResponse invoke(InvokeRequest request)

Invoke function

Parameters:

request -

Returns: