@rockset/cli/lib/commands/api/virtualInstances/setVirtualInstance.js

Official Rockset CLI

"use strict";
/* eslint-disable unicorn/filename-case */
// Generated file, please do not edit directly
Object.defineProperty(exports, "__esModule", { value: true });
const core_1 = require("@oclif/core");
const core_2 = require("@rockset/core");
const util_1 = require("../../../helper/util");
const base_command_1 = require("../../../base-command");
const chalk = require("chalk");
const cli_ux_1 = require("cli-ux");
const bodySchema = `new_size: LARGE
new_type: null
monitoring_enabled: null
`;
let SetVirtualInstance = /** @class */ (() => {
    class SetVirtualInstance extends base_command_1.RockCommand {
        async run() {
            const { args, flags } = await this.parse(SetVirtualInstance);
            // Rockset client object
            const client = await core_2.main.createClient();
            const namedArgs = SetVirtualInstance.args;
            // apicall
            const apicall = client.virtualInstances.setVirtualInstance.bind(client.virtualInstances);
            // endpoint
            const endpoint = '/v1/orgs/self/virtualinstances/{virtualInstanceId}';
            const method = 'POST';
            await util_1.runApiCall.bind(this)({ args, flags, namedArgs, apicall, method, endpoint, bodySchema });
        }
    }
    SetVirtualInstance.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), body: core_1.Flags.string({
            required: true,
            description: 'Path to a file whose contents will be passed as the POST body of this request. Format must be [json|yaml]. An example schema is shown below.',
        }), raw: core_1.Flags.boolean({
            description: 'Show the raw output from the server, instead of grabbing the results. Usually used in conjunction with --output=json',
        }) }, cli_ux_1.cli.table.flags({ only: ['columns', 'output'] }));
    SetVirtualInstance.args = [
        {
            name: 'virtualInstanceId',
            description: 'uuid of the virtual instance',
            required: true,
            hidden: false,
        },
    ];
    SetVirtualInstance.description = `update the properties of a virtual instance
Arguments to this command will be passed as URL parameters to ${chalk.bold(`POST: /v1/orgs/self/virtualinstances/{virtualInstanceId}`)}
${chalk.bold(`This endpoint REQUIRES a POST body. To specify a POST body, please pass a JSON or YAML file to the --body flag.
       `)}
Example Body (YAML):
new_size: LARGE
new_type: null
monitoring_enabled: null


Endpoint Reference
POST: /v1/orgs/self/virtualinstances/{virtualInstanceId}
Update Virtual Instance
Update the properties of a virtual instance.

More documentation at ${chalk.underline(`https://docs.rockset.com/rest-api#setvirtualinstance`)}`;
    SetVirtualInstance.examples = [
        '$ rockset api:virtualInstances:setVirtualInstance VIRTUALINSTANCEID --body body.yaml\n$ cat body.yaml\nnew_size: LARGE\nnew_type: null\nmonitoring_enabled: null\n\n',
    ];
    return SetVirtualInstance;
})();
exports.default = SetVirtualInstance;