docs.unity3d.com
    Show / Hide Table of Contents

    Class GameSimApiClient

    Inheritance
    Object
    Object
    ScriptableObject
    UnityEditor.ScriptableSingleton<GameSimApiClient>
    GameSimApiClient
    Inherited Members
    UnityEditor.ScriptableSingleton<Unity.Simulation.Games.Editor.GameSimApiClient>.Save(System.Boolean)
    UnityEditor.ScriptableSingleton<Unity.Simulation.Games.Editor.GameSimApiClient>.instance
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: Unity.Simulation.Games.Editor
    Syntax
    public class GameSimApiClient : ScriptableSingleton<GameSimApiClient>

    Methods

    CreateJob(String, String, Dictionary<String, Tuple<String, String>>, String, String)

    Declaration
    public string CreateJob(string jobName, string buildId, Dictionary<string, Tuple<string, string>> parameters, string maxRuns, string maxRuntime)
    Parameters
    Type Name Description
    String jobName
    String buildId
    Dictionary<String, Tuple<String, String>> parameters
    String maxRuns
    String maxRuntime
    Returns
    Type Description
    String

    DescribeJob(String)

    Describes a job

    Declaration
    public UnityWebRequestAsyncOperation DescribeJob(string jobId)
    Parameters
    Type Name Description
    String jobId

    ID of the job to query

    Returns
    Type Description
    UnityWebRequestAsyncOperation

    Web response for v1/jobs/{jobId}/describe api endpoint

    GetBuilds()

    Get Builds

    Declaration
    public UnityWebRequestAsyncOperation GetBuilds()
    Returns
    Type Description
    UnityWebRequestAsyncOperation

    Web response for /v1/builds/list api endpoint

    ListJobs()

    Lists all jobs under the current organization

    Declaration
    public UnityWebRequestAsyncOperation ListJobs()
    Returns
    Type Description
    UnityWebRequestAsyncOperation

    Web response to /v1/jobs/list api endpoint

    UploadBuild(String, String, List<String>)

    Requests a build URL and uploads a zipped build. Only supports linux x86_64 target

    Declaration
    public string UploadBuild(string name, string location, List<string> simulationMetrics)
    Parameters
    Type Name Description
    String name

    build name for display in Unity Game Simulation's web ui

    String location

    zip file containing the build

    List<String> simulationMetrics

    list of metrics associated with this build

    Returns
    Type Description
    String

    build id from Unity Game Simulation platform services

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023