Skip to content

README.md

Latest commit

 

History

History
426 lines (294 loc) · 22.2 KB

README.md

File metadata and controls

426 lines (294 loc) · 22.2 KB
Raw

FleetsV1

(FleetsV1)

Overview

Operations to manage and view a fleet.

Available Operations

CreateFleetDeprecated

CreateFleetDeprecated

Example Usage

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

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

CreateFleetDeprecatedRequest req = new CreateFleetDeprecatedRequest() {
    CreateFleet = new CreateFleet() {
        AutoscalerConfig = new AutoscalerConfig() {
            ScaleUpThreshold = 78718,
        },
        Name = "production",
        NodeShape = NodeShape.GpuH1004104936,
    },
};


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

Parameters

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

Response

CreateFleetDeprecatedResponse

Errors

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

GetFleetDeprecated

Returns a fleet.

Example Usage

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

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

GetFleetDeprecatedRequest req = new GetFleetDeprecatedRequest() {
    FleetId = "<id>",
};


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

Parameters

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

Response

GetFleetDeprecatedResponse

Errors

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

GetFleetMetricsDeprecated

Gets aggregate metrics for a fleet.

Example Usage

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

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

GetFleetMetricsDeprecatedRequest req = new GetFleetMetricsDeprecatedRequest() {
    FleetId = "<id>",
};


using(var res = await sdk.FleetsV1.GetFleetMetricsDeprecatedAsync(req))
{
    // 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
HathoraCloud.Models.Errors.ApiError 401, 404, 408, 422, 429 application/json
HathoraCloud.Models.Errors.ApiError 500 application/json
HathoraCloud.Models.Errors.SDKException 4XX, 5XX */*

GetFleetRegionDeprecated

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(
    orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    });

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


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

Parameters

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

Response

GetFleetRegionDeprecatedResponse

Errors

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

GetFleetRegionMetricsDeprecated

Gets metrics for a region in a fleet.

Example Usage

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

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

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


using(var res = await sdk.FleetsV1.GetFleetRegionMetricsDeprecatedAsync(req))
{
    // 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
HathoraCloud.Models.Errors.ApiError 401, 404, 408, 422, 429 application/json
HathoraCloud.Models.Errors.ApiError 500 application/json
HathoraCloud.Models.Errors.SDKException 4XX, 5XX */*

GetFleetsDeprecated

Returns an array of fleets.

Example Usage

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

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

GetFleetsDeprecatedRequest req = new GetFleetsDeprecatedRequest() {};


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

Parameters

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

Response

GetFleetsDeprecatedResponse

Errors

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

UpdateFleetDeprecated

Updates a fleet's configuration.

Example Usage

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

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

UpdateFleetDeprecatedRequest req = new UpdateFleetDeprecatedRequest() {
    UpdateFleet = new UpdateFleet() {
        AutoscalerConfig = new AutoscalerConfig() {
            ScaleUpThreshold = 638855,
        },
        Name = "production",
    },
    FleetId = "<id>",
};


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

Parameters

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

Response

UpdateFleetDeprecatedResponse

Errors

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

UpdateFleetRegionDeprecated

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(
    orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    });

UpdateFleetRegionDeprecatedRequest req = new UpdateFleetRegionDeprecatedRequest() {
    FleetRegionConfig = new FleetRegionConfig() {
        CloudMinVcpus = 122781,
    },
    FleetId = "<id>",
    Region = Region.Johannesburg,
};


using(var res = await sdk.FleetsV1.UpdateFleetRegionDeprecatedAsync(req))
{
    // 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
HathoraCloud.Models.Errors.ApiError 401, 404, 408, 422, 429 application/json
HathoraCloud.Models.Errors.ApiError 500 application/json
HathoraCloud.Models.Errors.SDKException 4XX, 5XX */*