Skip to content

Latest commit

 

History

History
212 lines (144 loc) · 9.43 KB

README.md

File metadata and controls

212 lines (144 loc) · 9.43 KB

FleetsV1

(FleetsV1)

Overview

Operations to manage and view a fleet.

Available Operations

GetFleetMetrics

Gets metrics for a fleet in a region.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;
using System.Collections.Generic;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39");

GetFleetMetricsRequest req = new GetFleetMetricsRequest() {
    FleetId = "<id>",
    Region = Region.London,
};


using(var res = await sdk.FleetsV1.GetFleetMetricsAsync(req))
{
    // handle response
}

Parameters

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

Response

GetFleetMetricsResponse

Errors

Error Type Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401, 404, 422, 429 application/json
HathoraCloud.Models.Errors.ApiError 500 application/json
HathoraCloud.Models.Errors.SDKException 4XX, 5XX */*

GetFleetRegion

Gets the configuration for a given fleet in a region.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39");

GetFleetRegionRequest req = new GetFleetRegionRequest() {
    FleetId = "<id>",
    Region = Region.SaoPaulo,
};


using(var res = await sdk.FleetsV1.GetFleetRegionAsync(req))
{
    // handle response
}

Parameters

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

Response

GetFleetRegionResponse

Errors

Error Type Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401, 404, 422, 429 application/json
HathoraCloud.Models.Errors.SDKException 4XX, 5XX */*

GetFleets

Returns an array of fleets.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39");

GetFleetsRequest req = new GetFleetsRequest() {};


using(var res = await sdk.FleetsV1.GetFleetsAsync(req))
{
    // handle response
}

Parameters

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

Response

GetFleetsResponse

Errors

Error Type Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401, 404, 429 application/json
HathoraCloud.Models.Errors.SDKException 4XX, 5XX */*

UpdateFleetRegion

Updates the configuration for a given fleet in a region.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39");

UpdateFleetRegionRequest req = new UpdateFleetRegionRequest() {
    FleetRegionConfig = new FleetRegionConfig() {
        CloudMinVcpus = 511402,
    },
    FleetId = "<id>",
    Region = Region.Singapore,
};


using(var res = await sdk.FleetsV1.UpdateFleetRegionAsync(req))
{
    // handle response
}

Parameters

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

Response

UpdateFleetRegionResponse

Errors

Error Type Status Code Content Type
HathoraCloud.Models.Errors.ApiError 401, 404, 422, 429 application/json
HathoraCloud.Models.Errors.ApiError 500 application/json
HathoraCloud.Models.Errors.SDKException 4XX, 5XX */*