View Source ExOciSdk.Client (ex_oci_sdk v0.2.1)

Main client for interacting with the OCI API. Manages configurations, HTTP client, and JSON serialization.

Summary

Functions

Creates a new instance of the OCI client.

Types

client_option()

@type client_option() :: {module(), keyword()}

create_opts()

@type create_opts() :: [http_client: client_option(), json: client_option()]

t()

@type t() :: %ExOciSdk.Client{
  config: ExOciSdk.Config.t(),
  http_client: client_option(),
  json: client_option()
}

Functions

create!(config, opts \\ [])

@spec create!(ExOciSdk.Config.t(), create_opts()) :: t() | no_return()

Creates a new instance of the OCI client.

Parameters

  • config - Required configuration for the client
  • opts - Optional parameters to customize the client
    • :http_client - Tuple with {module, options} for the HTTP client. Module must implements ExOciSdk.HTTPClient
    • :json - Tuple with {module, options} for JSON serialization. Module must implements ExOciSdk.JSON

Returns

  • t/0 - The configuration struct

Raises