Class CloudCodeModulesAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

CloudCodeModulesAdminApi

Implements

ICloudCodeModulesAdminApi

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Admin.CloudCode

Assembly: Unity.Services.Apis.dll

Syntax

public class CloudCodeModulesAdminApi : ICloudCodeModulesAdminApi, IApiAccessor

Constructors

CloudCodeModulesAdminApi(IApiClient)

Initializes a new instance of the CloudCodeModulesAdminApi class using a Configuration object and client instance.

Declaration

public CloudCodeModulesAdminApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

CloudCodeModulesAdminApi(IApiClient, IApiConfiguration)

Initializes a new instance of the CloudCodeModulesAdminApi class using a Configuration object and client instance.

Declaration

public CloudCodeModulesAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	An instance of the Configuration

Methods

DeleteModule(string, string, string, CancellationToken)

Delete module Delete a Cloud Code module within a project environment. Creating, updating, or deleting a module is not instant as changes roll out gradually. This ensures that there are never any periods of downtime in which Cloud Code is not available to serve requests. ### UGS CLI You can also delete a module through the UGS CLI with the [delete module command]. [delete module command]: /guides/ugs-cli/latest/cloud-code/Cloud%20Code%20Command%20Line/Commands/Modules/delete

Declaration

public ApiOperation DeleteModule(string projectId, string environmentId, string moduleName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
string	moduleName	Name of a Cloud Code module.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetModule(string, string, string, CancellationToken)

Get module Get useful information about a Cloud Code module within a project environment. This information does not include the compiled module package last uploaded when creating or updating a module. ### UGS CLI You can also get information about a module through the UGS CLI with the [get module command]. [get module command]: /guides/ugs-cli/latest/cloud-code/Cloud%20Code%20Command%20Line/Commands/Modules/get

Declaration

public ApiOperation<GetModuleResponse> GetModule(string projectId, string environmentId, string moduleName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
string	moduleName	Name of a Cloud Code module.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetModuleResponse>	The operation

ListModules(string, string, int?, string, CancellationToken)

List modules Get a list of Cloud Code modules within a project environment. This endpoint supports token-based pagination. ### UGS CLI You an also list modules through the UGS CLI with the [list modules command]. [list modules command]: /guides/ugs-cli/latest/cloud-code/Cloud%20Code%20Command%20Line/Commands/Modules/list

Declaration

public ApiOperation<ListModulesResponse> ListModules(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 modules to return. (optional)
string	after	Page token (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ListModulesResponse>	The operation

Implements

ICloudCodeModulesAdminApi

IApiAccessor