FleetsV1

(fleetsV1())

Overview

Operations to manage and view a fleet.

Available Operations

createFleetDeprecated - CreateFleetDeprecated
getFleetDeprecated - GetFleetDeprecated
getFleetMetricsDeprecated - GetFleetMetricsDeprecated
getFleetRegionDeprecated - GetFleetRegionDeprecated
getFleetRegionMetricsDeprecated - GetFleetRegionMetricsDeprecated
getFleetsDeprecated - GetFleetsDeprecated
updateFleetDeprecated - UpdateFleetDeprecated
updateFleetRegionDeprecated - UpdateFleetRegionDeprecated

createFleetDeprecated

CreateFleetDeprecated

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.CreateFleetDeprecatedResponse;
import dev.hathora.cloud_sdk.models.shared.*;
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();

        CreateFleetDeprecatedResponse res = sdk.fleetsV1().createFleetDeprecated()
                .createFleet(CreateFleet.builder()
                    .autoscalerConfig(AutoscalerConfig.builder()
                        .scaleUpThreshold(78718)
                        .build())
                    .name("production")
                    .nodeShape(NodeShape.GPU_H100252468)
                    .build())
                .call();

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

Parameters

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

Response

CreateFleetDeprecatedResponse

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	/

getFleetDeprecated

Returns a fleet.

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.GetFleetDeprecatedResponse;
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();

        GetFleetDeprecatedResponse res = sdk.fleetsV1().getFleetDeprecated()
                .fleetId("<id>")
                .call();

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

Parameters

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

Response

GetFleetDeprecatedResponse

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	/

getFleetMetricsDeprecated

Gets aggregate metrics for a fleet.

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.GetFleetMetricsDeprecatedRequest;
import dev.hathora.cloud_sdk.models.operations.GetFleetMetricsDeprecatedResponse;
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();

        GetFleetMetricsDeprecatedRequest req = GetFleetMetricsDeprecatedRequest.builder()
                .fleetId("<id>")
                .build();

        GetFleetMetricsDeprecatedResponse res = sdk.fleetsV1().getFleetMetricsDeprecated()
                .request(req)
                .call();

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

Parameters

Parameter	Type	Required	Description
`request`	GetFleetMetricsDeprecatedRequest	✔️	The request object to use for the request.

Response

GetFleetMetricsDeprecatedResponse

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	/

getFleetRegionDeprecated

Gets the configuration for a given fleet in a region.

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.GetFleetRegionDeprecatedResponse;
import dev.hathora.cloud_sdk.models.shared.Region;
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();

        GetFleetRegionDeprecatedResponse res = sdk.fleetsV1().getFleetRegionDeprecated()
                .fleetId("<id>")
                .region(Region.SAO_PAULO)
                .call();

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

Parameters

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

Response

GetFleetRegionDeprecatedResponse

Errors

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

getFleetRegionMetricsDeprecated

Gets metrics for a region in a fleet.

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.GetFleetRegionMetricsDeprecatedRequest;
import dev.hathora.cloud_sdk.models.operations.GetFleetRegionMetricsDeprecatedResponse;
import dev.hathora.cloud_sdk.models.shared.Region;
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();

        GetFleetRegionMetricsDeprecatedRequest req = GetFleetRegionMetricsDeprecatedRequest.builder()
                .fleetId("<id>")
                .region(Region.DUBAI)
                .build();

        GetFleetRegionMetricsDeprecatedResponse res = sdk.fleetsV1().getFleetRegionMetricsDeprecated()
                .request(req)
                .call();

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

Parameters

Parameter	Type	Required	Description
`request`	GetFleetRegionMetricsDeprecatedRequest	✔️	The request object to use for the request.

Response

GetFleetRegionMetricsDeprecatedResponse

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	/

getFleetsDeprecated

Returns an array of fleets.

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.GetFleetsDeprecatedResponse;
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();

        GetFleetsDeprecatedResponse res = sdk.fleetsV1().getFleetsDeprecated()
                .call();

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

Parameters

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

Response

GetFleetsDeprecatedResponse

Errors

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

updateFleetDeprecated

Updates a fleet's configuration.

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.UpdateFleetDeprecatedResponse;
import dev.hathora.cloud_sdk.models.shared.*;
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();

        UpdateFleetDeprecatedResponse res = sdk.fleetsV1().updateFleetDeprecated()
                .updateFleet(UpdateFleet.builder()
                    .autoscalerConfig(AutoscalerConfig.builder()
                        .scaleUpThreshold(638855)
                        .build())
                    .name("production")
                    .build())
                .fleetId("<id>")
                .call();

        // handle response
    }
}

Parameters

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

Response

UpdateFleetDeprecatedResponse

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	/

updateFleetRegionDeprecated

Updates the configuration for a given fleet in a region.

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.UpdateFleetRegionDeprecatedRequest;
import dev.hathora.cloud_sdk.models.operations.UpdateFleetRegionDeprecatedResponse;
import dev.hathora.cloud_sdk.models.shared.*;
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();

        UpdateFleetRegionDeprecatedRequest req = UpdateFleetRegionDeprecatedRequest.builder()
                .fleetRegionConfig(FleetRegionConfig.builder()
                    .cloudMinVcpus(122781)
                    .build())
                .fleetId("<id>")
                .region(Region.JOHANNESBURG)
                .build();

        UpdateFleetRegionDeprecatedResponse res = sdk.fleetsV1().updateFleetRegionDeprecated()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`request`	UpdateFleetRegionDeprecatedRequest	✔️	The request object to use for the request.

Response

UpdateFleetRegionDeprecatedResponse

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	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

FleetsV1

Overview

Available Operations

createFleetDeprecated

Example Usage

Parameters

Response

Errors

getFleetDeprecated

Example Usage

Parameters

Response

Errors

getFleetMetricsDeprecated

Example Usage

Parameters

Response

Errors

getFleetRegionDeprecated

Example Usage

Parameters

Response

Errors

getFleetRegionMetricsDeprecated

Example Usage

Parameters

Response

Errors

getFleetsDeprecated

Example Usage

Parameters

Response

Errors

updateFleetDeprecated

Example Usage

Parameters

Response

Errors

updateFleetRegionDeprecated

Example Usage

Parameters

Response

Errors