BuildsV3

(buildsV3())

Overview

Operations that allow you create and manage your builds.

Available Operations

createBuild - CreateBuild
createBuildRegistry - CreateBuildRegistry
deleteBuild - DeleteBuild
getBuild - GetBuild
getBuilds - GetBuilds
runBuild - RunBuild
runBuildRegistry - RunBuildRegistry

createBuild

Creates a new build with optional multipartUploadUrls that can be used to upload larger builds in parts before calling runBuild. Responds with a buildId that you must pass to RunBuild() to build the game server artifact. You can optionally pass in a buildTag to associate an external version with a build.

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.CreateBuildResponse;
import dev.hathora.cloud_sdk.models.shared.CreateMultipartBuildParams;
import dev.hathora.cloud_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
                .security(Security.builder()
                    .hathoraDevToken(System.getenv().getOrDefault("HATHORA_DEV_TOKEN", ""))
                    .build())
            .build();

        CreateBuildResponse res = sdk.buildsV3().createBuild()
                .createMultipartBuildParams(CreateMultipartBuildParams.builder()
                    .buildSizeInBytes(2645.24)
                    .buildId("bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5")
                    .buildTag("0.1.14-14c793")
                    .build())
                .call();

        if (res.createdBuildV3WithMultipartUrls().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`createMultipartBuildParams`	CreateMultipartBuildParams	✔️	N/A
`orgId`	Optional<String>	➖	N/A	org-6f706e83-0ec1-437a-9a46-7d4281eb2f39

Response

CreateBuildResponse

Errors

Error Type	Status Code	Content Type
models/errors/ApiError	400, 401, 404, 408, 422, 429	application/json
models/errors/ApiError	500	application/json
models/errors/SDKError	4XX, 5XX	/

createBuildRegistry

Creates a new build to be used with runBuildRegistry. Responds with a buildId that you must pass to RunBuildRegistry() to build the game server artifact. You can optionally pass in a buildTag to associate an external version with a build.

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.CreateBuildRegistryResponse;
import dev.hathora.cloud_sdk.models.shared.CreateBuildV3Params;
import dev.hathora.cloud_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
                .security(Security.builder()
                    .hathoraDevToken(System.getenv().getOrDefault("HATHORA_DEV_TOKEN", ""))
                    .build())
            .build();

        CreateBuildRegistryResponse res = sdk.buildsV3().createBuildRegistry()
                .createBuildV3Params(CreateBuildV3Params.builder()
                    .buildId("bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5")
                    .buildTag("0.1.14-14c793")
                    .build())
                .call();

        if (res.buildV3().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`createBuildV3Params`	CreateBuildV3Params	✔️	N/A
`orgId`	Optional<String>	➖	N/A	org-6f706e83-0ec1-437a-9a46-7d4281eb2f39

Response

CreateBuildRegistryResponse

Errors

Error Type	Status Code	Content Type
models/errors/ApiError	400, 401, 404, 408, 422, 429	application/json
models/errors/ApiError	500	application/json
models/errors/SDKError	4XX, 5XX	/

deleteBuild

Delete a build. All associated metadata is deleted. Be careful which builds you delete. This endpoint does not prevent you from deleting actively used builds. Deleting a build that is actively build used by an app's deployment will cause failures when creating rooms.

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.DeleteBuildResponse;
import dev.hathora.cloud_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
                .security(Security.builder()
                    .hathoraDevToken(System.getenv().getOrDefault("HATHORA_DEV_TOKEN", ""))
                    .build())
            .build();

        DeleteBuildResponse res = sdk.buildsV3().deleteBuild()
                .buildId("bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5")
                .call();

        if (res.deletedBuild().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`buildId`	String	✔️	N/A	bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5
`orgId`	Optional<String>	➖	N/A	org-6f706e83-0ec1-437a-9a46-7d4281eb2f39

Response

DeleteBuildResponse

Errors

Error Type	Status Code	Content Type
models/errors/ApiError	401, 404, 408, 422, 429	application/json
models/errors/ApiError	500	application/json
models/errors/SDKError	4XX, 5XX	/

getBuild

Get details for a build.

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.GetBuildResponse;
import dev.hathora.cloud_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
                .security(Security.builder()
                    .hathoraDevToken(System.getenv().getOrDefault("HATHORA_DEV_TOKEN", ""))
                    .build())
            .build();

        GetBuildResponse res = sdk.buildsV3().getBuild()
                .buildId("bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5")
                .call();

        if (res.buildV3().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`buildId`	String	✔️	N/A	bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5
`orgId`	Optional<String>	➖	N/A	org-6f706e83-0ec1-437a-9a46-7d4281eb2f39

Response

GetBuildResponse

Errors

Error Type	Status Code	Content Type
models/errors/ApiError	401, 404, 408, 429	application/json
models/errors/SDKError	4XX, 5XX	/

getBuilds

Returns an array of builds for an application.

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.GetBuildsResponse;
import dev.hathora.cloud_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
                .security(Security.builder()
                    .hathoraDevToken(System.getenv().getOrDefault("HATHORA_DEV_TOKEN", ""))
                    .build())
            .build();

        GetBuildsResponse res = sdk.buildsV3().getBuilds()
                .call();

        if (res.buildsV3Page().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`orgId`	Optional<String>	➖	N/A	org-6f706e83-0ec1-437a-9a46-7d4281eb2f39

Response

GetBuildsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ApiError	401, 404, 408, 422, 429	application/json
models/errors/SDKError	4XX, 5XX	/

runBuild

Builds a game server artifact from a tarball you provide. Pass in the buildId generated from CreateBuild().

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.RunBuildResponse;
import dev.hathora.cloud_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
                .security(Security.builder()
                    .hathoraDevToken(System.getenv().getOrDefault("HATHORA_DEV_TOKEN", ""))
                    .build())
            .build();

        RunBuildResponse res = sdk.buildsV3().runBuild()
                .buildId("bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5")
                .call();

        if (res.responseStream().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`buildId`	String	✔️	N/A	bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5
`orgId`	Optional<String>	➖	N/A	org-6f706e83-0ec1-437a-9a46-7d4281eb2f39

Response

RunBuildResponse

Errors

Error Type	Status Code	Content Type
models/errors/ApiError	400, 401, 404, 408, 422, 429	application/json
models/errors/ApiError	500	application/json
models/errors/SDKError	4XX, 5XX	/

runBuildRegistry

Builds a game server artifact from a public or private registry. Pass in the buildId generated from CreateBuild().

Example Usage

package hello.world;

import dev.hathora.cloud_sdk.HathoraCloud;
import dev.hathora.cloud_sdk.models.errors.ApiError;
import dev.hathora.cloud_sdk.models.operations.RunBuildRegistryResponse;
import dev.hathora.cloud_sdk.models.shared.RegistryConfig;
import dev.hathora.cloud_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ApiError, Exception {

        HathoraCloud sdk = HathoraCloud.builder()
                .orgId("org-6f706e83-0ec1-437a-9a46-7d4281eb2f39")
                .security(Security.builder()
                    .hathoraDevToken(System.getenv().getOrDefault("HATHORA_DEV_TOKEN", ""))
                    .build())
            .build();

        RunBuildRegistryResponse res = sdk.buildsV3().runBuildRegistry()
                .registryConfig(RegistryConfig.builder()
                    .image("https://picsum.photos/seed/3gDPgtj/723/1525")
                    .build())
                .buildId("bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5")
                .call();

        if (res.responseStream().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`registryConfig`	RegistryConfig	✔️	N/A
`buildId`	String	✔️	N/A	bld-6d4c6a71-2d75-4b42-94e1-f312f57f33c5
`orgId`	Optional<String>	➖	N/A	org-6f706e83-0ec1-437a-9a46-7d4281eb2f39

Response

RunBuildRegistryResponse

Errors

Error Type	Status Code	Content Type
models/errors/ApiError	400, 401, 404, 408, 422, 429	application/json
models/errors/ApiError	500	application/json
models/errors/SDKError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

BuildsV3

Overview

Available Operations

createBuild

Example Usage

Parameters

Response

Errors

createBuildRegistry

Example Usage

Parameters

Response

Errors

deleteBuild

Example Usage

Parameters

Response

Errors

getBuild

Example Usage

Parameters

Response

Errors

getBuilds

Example Usage

Parameters

Response

Errors

runBuild

Example Usage

Parameters

Response

Errors

runBuildRegistry

Example Usage

Parameters

Response

Errors