Class: Infrawrench::KvNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.kv

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ KvNamespace

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of KvNamespace.

Parameters:



1858
1859
1860
 
# File 'lib/infrawrench/client.rb', line 1858

def initialize(transport)
  @transport = transport
end

Instance Method Details

#command(body:, org_id: nil, request_options: nil) ⇒ Hash

Run a Redis-style KV command

Requires permission: resources:execute.

POST /api/org/orgId/kv/command

Raises on 400: Bad request

Raises on 404: Not found

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • body (Hash) —

    Request body, shaped as KvCommandRequest.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • body: (kv_command_request)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as KvCommandResponse — see sig/infrawrench/sdk.rbs.

Raises:



1878
1879
1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/infrawrench/client.rb', line 1878

def command(body:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/kv/command",
    path_params: { "orgId" => org_id },
    body: body,
    request_options: request_options
  )
end