Interface ICloudCodeScriptsAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Admin.CloudCode

Assembly: Unity.Services.Apis.dll

Syntax

public interface ICloudCodeScriptsAdminApi : IApiAccessor

Methods

CreateScript(string, string, CreateScriptRequest, CancellationToken)

Create script

Declaration

ApiOperation CreateScript(string projectId, string environmentId, CreateScriptRequest createScriptRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
CreateScriptRequest	createScriptRequest	Provide script name, type and code. Parameters are optional. If no code is provided, a placeholder code example is used. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeleteScript(string, string, string, CancellationToken)

Delete script

Declaration

ApiOperation DeleteScript(string projectId, string environmentId, string scriptName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
string	scriptName	Name of the script.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

GetScript(string, string, string, CancellationToken)

Get script

Declaration

ApiOperation<GetScriptResponse> GetScript(string projectId, string environmentId, string scriptName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
string	scriptName	Name of the script.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetScriptResponse>	The operation

ListScripts(string, string, int?, string, CancellationToken)

List scripts

Declaration

ApiOperation<ListScriptsResponse> ListScripts(string projectId, string environmentId, int? limit = null, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
int?	limit	The number of scripts to return. (optional)
string	after	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ListScriptsResponse>	The operation

PublishScript(string, string, string, PublishScriptRequest, CancellationToken)

Publish script

Declaration

ApiOperation<PublishScriptResponse> PublishScript(string projectId, string environmentId, string scriptName, PublishScriptRequest publishScriptRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
string	scriptName	Name of the script.
PublishScriptRequest	publishScriptRequest	Optional. Provide a version number to publish if you want to republish an older version. By default, the working copy is published. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<PublishScriptResponse>	The operation

UpdateScript(string, string, string, UpdateScriptRequest, CancellationToken)

Update script

Declaration

ApiOperation UpdateScript(string projectId, string environmentId, string scriptName, UpdateScriptRequest updateScriptRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
string	scriptName	Name of the script.
UpdateScriptRequest	updateScriptRequest	Provide updated script code, parameters, or both. If you provide an empty parameters array, the present parameters will be removed. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation