Class GboxSDK

constructor

• new GboxSDK(clientOptions?: ClientOptions): GboxSDK

  Parameters

  • OptionalclientOptions: ClientOptions

  Returns GboxSDK

Readonlyclient

create

• create(body: CreateAndroid): Promise<AndroidBoxOperator>

  Parameters

  • body: CreateAndroid

  Returns Promise<AndroidBoxOperator>

  Example

  const box = await gboxSDK.create({
    type: 'android',
    config: { labels: { FOO: 'bar' }, envs: { FOO: 'bar' } },
  });
  Copy

• create(body: CreateLinux): Promise<LinuxBoxOperator>

  Parameters

  • body: CreateLinux

  Returns Promise<LinuxBoxOperator>

  Example

  const box = await gboxSDK.create({
    type: 'linux',
    config: { envs: { FOO: 'bar' } },
  });
  Copy

get

• get(id: string): Promise<BoxOperator>

  Parameters

  • id: string

  Returns Promise<BoxOperator>

  Example

  const box = await gboxSDK.get('975fed9f-bb28-4718-a2c5-e01f72864bd1');
  Copy

getInfo

• getInfo(id: string): Promise<GboxClient.V1.BoxRetrieveResponse>

  Parameters

  • id: string

  Returns Promise<GboxClient.V1.BoxRetrieveResponse>

  Example

  const boxInfo = await gboxSDK.get('975fed9f-bb28-4718-a2c5-e01f72864bd1');
  Copy

list

• list(query?: GboxClient.V1.BoxListParams): Promise<BoxListOperatorResponse>

  Parameters

  • Optionalquery: GboxClient.V1.BoxListParams

  Returns Promise<BoxListOperatorResponse>

  Example

  const boxes = await gboxSDK.list();
  or
  const boxes = await gboxSDK.list({
    page: 1,
    pageSize: 10,
  });
  Copy

listInfo

• listInfo(
      query?: GboxClient.V1.BoxListParams,
  ): Promise<GboxClient.V1.BoxListResponse>

  Parameters

  • Optionalquery: GboxClient.V1.BoxListParams

  Returns Promise<GboxClient.V1.BoxListResponse>

  Example

  const boxes = await gboxSDK.listInfo();
  or
  const boxes = await gboxSDK.listInfo({
    page: 1,
    pageSize: 10,
  });
  Copy

terminate

• terminate(id: string, body?: BoxTerminate): Promise<void>

  Parameters

  • id: string
  • Optionalbody: BoxTerminate

  Returns Promise<void>

  Example

  const response = await gboxSDK.terminate('box_id');
  Copy