com.tencentcloudapi.scf.v20180416

Class ScfClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.scf.v20180416.ScfClient

public class ScfClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
ScfClient(Credential credential, String region)
ScfClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
CopyFunctionResponse	CopyFunction(CopyFunctionRequest req) This API is used to replicate a function.
CreateAliasResponse	CreateAlias(CreateAliasRequest req) This API is used to create an alias for a function version.
CreateFunctionResponse	CreateFunction(CreateFunctionRequest req) This API is used to create a function based on the input parameters.
CreateNamespaceResponse	CreateNamespace(CreateNamespaceRequest req) This API is used to create a namespace based on the input parameters.
CreateTriggerResponse	CreateTrigger(CreateTriggerRequest req) This API is used to create a trigger based on the input parameters.
DeleteAliasResponse	DeleteAlias(DeleteAliasRequest req) This API is used to delete an alias of a function version.
DeleteFunctionResponse	DeleteFunction(DeleteFunctionRequest req) This API is used to delete a function based on the input parameters.
DeleteLayerVersionResponse	DeleteLayerVersion(DeleteLayerVersionRequest req) This API is used to delete a specified version of a specified layer.
DeleteNamespaceResponse	DeleteNamespace(DeleteNamespaceRequest req) This API is used to create a namespace based on the input parameters.
DeleteTriggerResponse	DeleteTrigger(DeleteTriggerRequest req) This API is used to delete an existing trigger based on the input parameters.
GetAliasResponse	GetAlias(GetAliasRequest req) This API is used to get the alias details such as the name, description, version, and routing information.
GetFunctionResponse	GetFunction(GetFunctionRequest req) This API is used to obtain function details, such as name, code, handler, associated trigger, and timeout.
GetFunctionAddressResponse	GetFunctionAddress(GetFunctionAddressRequest req) This API is used to obtain the download address of the function code package.
GetFunctionLogsResponse	GetFunctionLogs(GetFunctionLogsRequest req) This API is used to return function running logs according to the specified log query criteria.
GetLayerVersionResponse	GetLayerVersion(GetLayerVersionRequest req) This API is used to get the layer version details, including links used to download files in the layer.
InvokeResponse	Invoke(InvokeRequest req) This API is used to run a function.
ListAliasesResponse	ListAliases(ListAliasesRequest req) This API is used to return the list of all aliases under a function.
ListFunctionsResponse	ListFunctions(ListFunctionsRequest req) This API is used to return relevant function information based on the input query parameters.
ListLayersResponse	ListLayers(ListLayersRequest req) This API is used to return the list of all layers, including the information of the latest version of each layer.
ListLayerVersionsResponse	ListLayerVersions(ListLayerVersionsRequest req) This API is used to get the information of all versions of a specified layer.
ListNamespacesResponse	ListNamespaces(ListNamespacesRequest req) This API is used to display a namespace list.
ListTriggersResponse	ListTriggers(ListTriggersRequest req) This API is used to get the function trigger list.
ListVersionByFunctionResponse	ListVersionByFunction(ListVersionByFunctionRequest req) This API is used to query the function version based on the input parameters.
PublishLayerVersionResponse	PublishLayerVersion(PublishLayerVersionRequest req) This API is used to create a version for a layer by using the given .zip file or COS object.
PublishVersionResponse	PublishVersion(PublishVersionRequest req) This API is used for users to release a new version of the function.
UpdateAliasResponse	UpdateAlias(UpdateAliasRequest req) This API is used to update the configuration of an alias.
UpdateFunctionCodeResponse	UpdateFunctionCode(UpdateFunctionCodeRequest req) This API is used to update the function code based on the input parameters.
UpdateFunctionConfigurationResponse	UpdateFunctionConfiguration(UpdateFunctionConfigurationRequest req) This API is used to update the function configuration based on the input parameters.
UpdateNamespaceResponse	UpdateNamespace(UpdateNamespaceRequest req) This API is used to update a namespace.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

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

Constructor Detail

ScfClient

public ScfClient(Credential credential,
                 String region)

ScfClient

public ScfClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

CopyFunction

public CopyFunctionResponse CopyFunction(CopyFunctionRequest req)
                                  throws TencentCloudSDKException

This API is used to replicate a function. You can store the replicated function in a specified Region and Namespace. Note: This API **does not** replicate the following objects or attributes of the function: 1. Function trigger 2. Versions other than $LATEST 3. CLS target of the logs configured in the function You can manually configure the function after replication as required.

Parameters:

req - CopyFunctionRequest

Returns:

CopyFunctionResponse

Throws:

TencentCloudSDKException

CreateAlias

public CreateAliasResponse CreateAlias(CreateAliasRequest req)
                                throws TencentCloudSDKException

This API is used to create an alias for a function version. You can use the alias to mark a specific function version such as DEV/RELEASE. You can also modify the version pointed to by the alias at any time. An alias must point to a master version and can point to an additional version at the same time. If you specify an alias when invoking a function, the request will be sent to the versions pointed to by the alias. You can configure the ratio between the master version and additional version during request sending.

Parameters:

req - CreateAliasRequest

Returns:

CreateAliasResponse

Throws:

TencentCloudSDKException

CreateFunction

public CreateFunctionResponse CreateFunction(CreateFunctionRequest req)
                                      throws TencentCloudSDKException

This API is used to create a function based on the input parameters.

Parameters:

req - CreateFunctionRequest

Returns:

CreateFunctionResponse

Throws:

TencentCloudSDKException

CreateNamespace

public CreateNamespaceResponse CreateNamespace(CreateNamespaceRequest req)
                                        throws TencentCloudSDKException

This API is used to create a namespace based on the input parameters.

Parameters:

req - CreateNamespaceRequest

Returns:

CreateNamespaceResponse

Throws:

TencentCloudSDKException

CreateTrigger

public CreateTriggerResponse CreateTrigger(CreateTriggerRequest req)
                                    throws TencentCloudSDKException

This API is used to create a trigger based on the input parameters.

Parameters:

req - CreateTriggerRequest

Returns:

CreateTriggerResponse

Throws:

TencentCloudSDKException

DeleteAlias

public DeleteAliasResponse DeleteAlias(DeleteAliasRequest req)
                                throws TencentCloudSDKException

This API is used to delete an alias of a function version.

Parameters:

req - DeleteAliasRequest

Returns:

DeleteAliasResponse

Throws:

TencentCloudSDKException

DeleteFunction

public DeleteFunctionResponse DeleteFunction(DeleteFunctionRequest req)
                                      throws TencentCloudSDKException

This API is used to delete a function based on the input parameters.

Parameters:

req - DeleteFunctionRequest

Returns:

DeleteFunctionResponse

Throws:

TencentCloudSDKException

DeleteLayerVersion

public DeleteLayerVersionResponse DeleteLayerVersion(DeleteLayerVersionRequest req)
                                              throws TencentCloudSDKException

This API is used to delete a specified version of a specified layer. The deleted version cannot be associated with a function, but the deletion does not affect functions that are referencing this layer.

Parameters:

req - DeleteLayerVersionRequest

Returns:

DeleteLayerVersionResponse

Throws:

TencentCloudSDKException

DeleteNamespace

public DeleteNamespaceResponse DeleteNamespace(DeleteNamespaceRequest req)
                                        throws TencentCloudSDKException

This API is used to create a namespace based on the input parameters.

Parameters:

req - DeleteNamespaceRequest

Returns:

DeleteNamespaceResponse

Throws:

TencentCloudSDKException

DeleteTrigger

public DeleteTriggerResponse DeleteTrigger(DeleteTriggerRequest req)
                                    throws TencentCloudSDKException

This API is used to delete an existing trigger based on the input parameters.

Parameters:

req - DeleteTriggerRequest

Returns:

DeleteTriggerResponse

Throws:

TencentCloudSDKException

GetAlias

public GetAliasResponse GetAlias(GetAliasRequest req)
                          throws TencentCloudSDKException

This API is used to get the alias details such as the name, description, version, and routing information.

Parameters:

req - GetAliasRequest

Returns:

GetAliasResponse

Throws:

TencentCloudSDKException

GetFunction

public GetFunctionResponse GetFunction(GetFunctionRequest req)
                                throws TencentCloudSDKException

This API is used to obtain function details, such as name, code, handler, associated trigger, and timeout.

Parameters:

req - GetFunctionRequest

Returns:

GetFunctionResponse

Throws:

TencentCloudSDKException

GetFunctionAddress

public GetFunctionAddressResponse GetFunctionAddress(GetFunctionAddressRequest req)
                                              throws TencentCloudSDKException

This API is used to obtain the download address of the function code package.

Parameters:

req - GetFunctionAddressRequest

Returns:

GetFunctionAddressResponse

Throws:

TencentCloudSDKException

GetFunctionLogs

public GetFunctionLogsResponse GetFunctionLogs(GetFunctionLogsRequest req)
                                        throws TencentCloudSDKException

This API is used to return function running logs according to the specified log query criteria.

Parameters:

req - GetFunctionLogsRequest

Returns:

GetFunctionLogsResponse

Throws:

TencentCloudSDKException

GetLayerVersion

public GetLayerVersionResponse GetLayerVersion(GetLayerVersionRequest req)
                                        throws TencentCloudSDKException

This API is used to get the layer version details, including links used to download files in the layer.

Parameters:

req - GetLayerVersionRequest

Returns:

GetLayerVersionResponse

Throws:

TencentCloudSDKException

Invoke

public InvokeResponse Invoke(InvokeRequest req)
                      throws TencentCloudSDKException

This API is used to run a function.

Parameters:

req - InvokeRequest

Returns:

InvokeResponse

Throws:

TencentCloudSDKException

ListAliases

public ListAliasesResponse ListAliases(ListAliasesRequest req)
                                throws TencentCloudSDKException

This API is used to return the list of all aliases under a function. You can filter them by the specific function version.

Parameters:

req - ListAliasesRequest

Returns:

ListAliasesResponse

Throws:

TencentCloudSDKException

ListFunctions

public ListFunctionsResponse ListFunctions(ListFunctionsRequest req)
                                    throws TencentCloudSDKException

This API is used to return relevant function information based on the input query parameters.

Parameters:

req - ListFunctionsRequest

Returns:

ListFunctionsResponse

Throws:

TencentCloudSDKException

ListLayerVersions

public ListLayerVersionsResponse ListLayerVersions(ListLayerVersionsRequest req)
                                            throws TencentCloudSDKException

This API is used to get the information of all versions of a specified layer.

Parameters:

req - ListLayerVersionsRequest

Returns:

ListLayerVersionsResponse

Throws:

TencentCloudSDKException

ListLayers

public ListLayersResponse ListLayers(ListLayersRequest req)
                              throws TencentCloudSDKException

This API is used to return the list of all layers, including the information of the latest version of each layer. You can filter them by the compatible runtime.

Parameters:

req - ListLayersRequest

Returns:

ListLayersResponse

Throws:

TencentCloudSDKException

ListNamespaces

public ListNamespacesResponse ListNamespaces(ListNamespacesRequest req)
                                      throws TencentCloudSDKException

This API is used to display a namespace list.

Parameters:

req - ListNamespacesRequest

Returns:

ListNamespacesResponse

Throws:

TencentCloudSDKException

ListTriggers

public ListTriggersResponse ListTriggers(ListTriggersRequest req)
                                  throws TencentCloudSDKException

This API is used to get the function trigger list.

Parameters:

req - ListTriggersRequest

Returns:

ListTriggersResponse

Throws:

TencentCloudSDKException

ListVersionByFunction

public ListVersionByFunctionResponse ListVersionByFunction(ListVersionByFunctionRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the function version based on the input parameters.

Parameters:

req - ListVersionByFunctionRequest

Returns:

ListVersionByFunctionResponse

Throws:

TencentCloudSDKException

PublishLayerVersion

public PublishLayerVersionResponse PublishLayerVersion(PublishLayerVersionRequest req)
                                                throws TencentCloudSDKException

This API is used to create a version for a layer by using the given .zip file or COS object. Each time this API is called with the same layer name, a new version will be generated.

Parameters:

req - PublishLayerVersionRequest

Returns:

PublishLayerVersionResponse

Throws:

TencentCloudSDKException

PublishVersion

public PublishVersionResponse PublishVersion(PublishVersionRequest req)
                                      throws TencentCloudSDKException

This API is used for users to release a new version of the function.

Parameters:

req - PublishVersionRequest

Returns:

PublishVersionResponse

Throws:

TencentCloudSDKException

UpdateAlias

public UpdateAliasResponse UpdateAlias(UpdateAliasRequest req)
                                throws TencentCloudSDKException

This API is used to update the configuration of an alias.

Parameters:

req - UpdateAliasRequest

Returns:

UpdateAliasResponse

Throws:

TencentCloudSDKException

UpdateFunctionCode

public UpdateFunctionCodeResponse UpdateFunctionCode(UpdateFunctionCodeRequest req)
                                              throws TencentCloudSDKException

This API is used to update the function code based on the input parameters.

Parameters:

req - UpdateFunctionCodeRequest

Returns:

UpdateFunctionCodeResponse

Throws:

TencentCloudSDKException

UpdateFunctionConfiguration

public UpdateFunctionConfigurationResponse UpdateFunctionConfiguration(UpdateFunctionConfigurationRequest req)
                                                                throws TencentCloudSDKException

This API is used to update the function configuration based on the input parameters.

Parameters:

req - UpdateFunctionConfigurationRequest

Returns:

UpdateFunctionConfigurationResponse

Throws:

TencentCloudSDKException

UpdateNamespace

public UpdateNamespaceResponse UpdateNamespace(UpdateNamespaceRequest req)
                                        throws TencentCloudSDKException

This API is used to update a namespace.

Parameters:

req - UpdateNamespaceRequest

Returns:

UpdateNamespaceResponse

Throws:

TencentCloudSDKException