Documentation ¶
Overview ¶
Code generated by ogen, DO NOT EDIT.
Index ¶
- func WithServerURL(ctx context.Context, u *url.URL) context.Context
- type Catalog
- func (s *Catalog) Decode(d *jx.Decoder) error
- func (s *Catalog) Encode(e *jx.Encoder)
- func (s *Catalog) GetDescription() string
- func (s *Catalog) GetID() uint64
- func (s *Catalog) GetLabels() []string
- func (s *Catalog) GetName() string
- func (s *Catalog) GetTables() Tables
- func (s *Catalog) MarshalJSON() ([]byte, error)
- func (s *Catalog) SetDescription(val string)
- func (s *Catalog) SetID(val uint64)
- func (s *Catalog) SetLabels(val []string)
- func (s *Catalog) SetName(val string)
- func (s *Catalog) SetTables(val Tables)
- func (s *Catalog) UnmarshalJSON(data []byte) error
- func (s *Catalog) Validate() error
- type Catalogs
- type Client
- func (c *Client) DeleteCatalog(ctx context.Context, params DeleteCatalogParams) (DeleteCatalogRes, error)
- func (c *Client) DeleteNamespace(ctx context.Context, params DeleteNamespaceParams) (DeleteNamespaceRes, error)
- func (c *Client) DeleteNamespaceServiceAccount(ctx context.Context, params DeleteNamespaceServiceAccountParams) (DeleteNamespaceServiceAccountRes, error)
- func (c *Client) DeleteSource(ctx context.Context, params DeleteSourceParams) (DeleteSourceRes, error)
- func (c *Client) DeleteUser(ctx context.Context, params DeleteUserParams) (DeleteUserRes, error)
- func (c *Client) FetchSource(ctx context.Context, params FetchSourceParams) (FetchSourceRes, error)
- func (c *Client) GetAllNamespaces(ctx context.Context) (GetAllNamespacesRes, error)
- func (c *Client) GetCatalog(ctx context.Context, params GetCatalogParams) (GetCatalogRes, error)
- func (c *Client) GetCatalogs(ctx context.Context, params GetCatalogsParams) (Catalogs, error)
- func (c *Client) GetCluster(ctx context.Context) (GetClusterRes, error)
- func (c *Client) GetNamespaceServiceAccount(ctx context.Context, params GetNamespaceServiceAccountParams) (GetNamespaceServiceAccountRes, error)
- func (c *Client) GetNamespaceServiceAccounts(ctx context.Context, params GetNamespaceServiceAccountsParams) (GetNamespaceServiceAccountsRes, error)
- func (c *Client) GetSource(ctx context.Context, params GetSourceParams) (GetSourceRes, error)
- func (c *Client) GetSourceOptions(ctx context.Context, params GetSourceOptionsParams) (GetSourceOptionsRes, error)
- func (c *Client) GetSources(ctx context.Context, params GetSourcesParams) (GetSourcesRes, error)
- func (c *Client) GetUser(ctx context.Context, params GetUserParams) (GetUserRes, error)
- func (c *Client) NewCatalog(ctx context.Context, request *UpsertCatalog, params NewCatalogParams) (NewCatalogRes, error)
- func (c *Client) NewNamespace(ctx context.Context, request *NewNamespace) (NewNamespaceRes, error)
- func (c *Client) NewNamespaceServiceAccount(ctx context.Context, request *NewServiceAccount, ...) (NewNamespaceServiceAccountRes, error)
- func (c *Client) NewSource(ctx context.Context, request *NewSource, params NewSourceParams) (NewSourceRes, error)
- func (c *Client) NewUser(ctx context.Context, request *NewUser) (*User, error)
- func (c *Client) Query(ctx context.Context, params QueryParams) (QueryRes, error)
- func (c *Client) UpdateCatalog(ctx context.Context, request *UpsertCatalog, params UpdateCatalogParams) (UpdateCatalogRes, error)
- type ClientOption
- type Cluster
- func (s *Cluster) Decode(d *jx.Decoder) error
- func (s *Cluster) Encode(e *jx.Encoder)
- func (s *Cluster) GetHealthy() bool
- func (s *Cluster) GetLeader() uint64
- func (s *Cluster) GetNodes() []Node
- func (s *Cluster) MarshalJSON() ([]byte, error)
- func (s *Cluster) SetHealthy(val bool)
- func (s *Cluster) SetLeader(val uint64)
- func (s *Cluster) SetNodes(val []Node)
- func (s *Cluster) UnmarshalJSON(data []byte) error
- func (s *Cluster) Validate() error
- type Column
- func (s *Column) Decode(d *jx.Decoder) error
- func (s *Column) Encode(e *jx.Encoder)
- func (s *Column) GetCap() uint64
- func (s *Column) GetID() uint64
- func (s *Column) GetName() string
- func (s *Column) GetNullable() bool
- func (s *Column) GetType() string
- func (s *Column) MarshalJSON() ([]byte, error)
- func (s *Column) SetCap(val uint64)
- func (s *Column) SetID(val uint64)
- func (s *Column) SetName(val string)
- func (s *Column) SetNullable(val bool)
- func (s *Column) SetType(val string)
- func (s *Column) UnmarshalJSON(data []byte) error
- type DeleteCatalogOK
- type DeleteCatalogParams
- type DeleteCatalogRes
- type DeleteNamespaceOK
- type DeleteNamespaceParams
- type DeleteNamespaceRes
- type DeleteNamespaceServiceAccountOK
- type DeleteNamespaceServiceAccountParams
- type DeleteNamespaceServiceAccountRes
- type DeleteSourceOK
- type DeleteSourceParams
- type DeleteSourceRes
- type DeleteUserOK
- type DeleteUserParams
- type DeleteUserRes
- type ErrorHandler
- type FetchSourceParams
- type FetchSourceRes
- type GetAllNamespacesRes
- type GetCatalogParams
- type GetCatalogRes
- type GetCatalogsParams
- type GetClusterRes
- type GetNamespaceServiceAccountParams
- type GetNamespaceServiceAccountRes
- type GetNamespaceServiceAccountsParams
- type GetNamespaceServiceAccountsRes
- type GetSourceNotFound
- type GetSourceOptionsParams
- type GetSourceOptionsRes
- type GetSourceParams
- type GetSourceRes
- type GetSourceUnauthorized
- type GetSourcesParams
- type GetSourcesRes
- type GetUserParams
- type GetUserRes
- type Handler
- type Middleware
- type Namespace
- type Namespaces
- type NewCatalogParams
- type NewCatalogRes
- type NewNamespace
- type NewNamespaceRes
- type NewNamespaceServiceAccountParams
- type NewNamespaceServiceAccountRes
- type NewServiceAccount
- func (s *NewServiceAccount) Decode(d *jx.Decoder) error
- func (s *NewServiceAccount) Encode(e *jx.Encoder)
- func (s *NewServiceAccount) GetDescription() string
- func (s *NewServiceAccount) GetLabels() []string
- func (s *NewServiceAccount) GetName() string
- func (s *NewServiceAccount) GetPrincipal() OptString
- func (s *NewServiceAccount) MarshalJSON() ([]byte, error)
- func (s *NewServiceAccount) SetDescription(val string)
- func (s *NewServiceAccount) SetLabels(val []string)
- func (s *NewServiceAccount) SetName(val string)
- func (s *NewServiceAccount) SetPrincipal(val OptString)
- func (s *NewServiceAccount) UnmarshalJSON(data []byte) error
- func (s *NewServiceAccount) Validate() error
- type NewSource
- func (s *NewSource) Decode(d *jx.Decoder) error
- func (s *NewSource) Encode(e *jx.Encoder)
- func (s *NewSource) GetConnector() string
- func (s *NewSource) GetName() string
- func (s *NewSource) GetOptions() SourceOptions
- func (s *NewSource) MarshalJSON() ([]byte, error)
- func (s *NewSource) SetConnector(val string)
- func (s *NewSource) SetName(val string)
- func (s *NewSource) SetOptions(val SourceOptions)
- func (s *NewSource) UnmarshalJSON(data []byte) error
- type NewSourceParams
- type NewSourceRes
- type NewUser
- func (s *NewUser) Decode(d *jx.Decoder) error
- func (s *NewUser) Encode(e *jx.Encoder)
- func (s *NewUser) GetEmail() string
- func (s *NewUser) GetFullName() string
- func (s *NewUser) GetPassword() string
- func (s *NewUser) GetUsername() string
- func (s *NewUser) MarshalJSON() ([]byte, error)
- func (s *NewUser) SetEmail(val string)
- func (s *NewUser) SetFullName(val string)
- func (s *NewUser) SetPassword(val string)
- func (s *NewUser) SetUsername(val string)
- func (s *NewUser) UnmarshalJSON(data []byte) error
- func (s *NewUser) Validate() error
- type Node
- func (s *Node) Decode(d *jx.Decoder) error
- func (s *Node) Encode(e *jx.Encoder)
- func (s *Node) GetAddress() string
- func (s *Node) GetHealthy() bool
- func (s *Node) GetID() uint64
- func (s *Node) GetReady() bool
- func (s *Node) MarshalJSON() ([]byte, error)
- func (s *Node) SetAddress(val string)
- func (s *Node) SetHealthy(val bool)
- func (s *Node) SetID(val uint64)
- func (s *Node) SetReady(val bool)
- func (s *Node) UnmarshalJSON(data []byte) error
- type OptString
- func (o *OptString) Decode(d *jx.Decoder) error
- func (o OptString) Encode(e *jx.Encoder)
- func (o OptString) Get() (v string, ok bool)
- func (o OptString) IsSet() bool
- func (s OptString) MarshalJSON() ([]byte, error)
- func (o OptString) Or(d string) string
- func (o *OptString) Reset()
- func (o *OptString) SetTo(v string)
- func (s *OptString) UnmarshalJSON(data []byte) error
- type Option
- type Problem
- func (s *Problem) Decode(d *jx.Decoder) error
- func (s *Problem) Encode(e *jx.Encoder)
- func (s *Problem) GetDetail() string
- func (s *Problem) GetTitle() string
- func (s *Problem) MarshalJSON() ([]byte, error)
- func (s *Problem) SetDetail(val string)
- func (s *Problem) SetTitle(val string)
- func (s *Problem) UnmarshalJSON(data []byte) error
- type QueryBadRequest
- type QueryParams
- type QueryRes
- type QueryUnauthorized
- type Route
- type Rows
- func (s *Rows) Decode(d *jx.Decoder) error
- func (s *Rows) Encode(e *jx.Encoder)
- func (s *Rows) GetColumns() []Column
- func (s *Rows) GetRows() [][]jx.Raw
- func (s *Rows) MarshalJSON() ([]byte, error)
- func (s *Rows) SetColumns(val []Column)
- func (s *Rows) SetRows(val [][]jx.Raw)
- func (s *Rows) UnmarshalJSON(data []byte) error
- func (s *Rows) Validate() error
- type Server
- type ServerOption
- func WithErrorHandler(h ErrorHandler) ServerOption
- func WithMaxMultipartMemory(max int64) ServerOption
- func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption
- func WithMiddleware(m ...Middleware) ServerOption
- func WithNotFound(notFound http.HandlerFunc) ServerOption
- func WithPathPrefix(prefix string) ServerOption
- type ServiceAccount
- func (s *ServiceAccount) Decode(d *jx.Decoder) error
- func (s *ServiceAccount) Encode(e *jx.Encoder)
- func (s *ServiceAccount) GetDescription() string
- func (s *ServiceAccount) GetLabels() []string
- func (s *ServiceAccount) GetName() string
- func (s *ServiceAccount) GetPrincipal() string
- func (s *ServiceAccount) MarshalJSON() ([]byte, error)
- func (s *ServiceAccount) SetDescription(val string)
- func (s *ServiceAccount) SetLabels(val []string)
- func (s *ServiceAccount) SetName(val string)
- func (s *ServiceAccount) SetPrincipal(val string)
- func (s *ServiceAccount) UnmarshalJSON(data []byte) error
- func (s *ServiceAccount) Validate() error
- type ServiceAccounts
- type Source
- func (s *Source) Decode(d *jx.Decoder) error
- func (s *Source) Encode(e *jx.Encoder)
- func (s *Source) GetConnector() string
- func (s *Source) GetHealthy() bool
- func (s *Source) GetID() uint64
- func (s *Source) GetName() string
- func (s *Source) GetTables() Tables
- func (s *Source) MarshalJSON() ([]byte, error)
- func (s *Source) SetConnector(val string)
- func (s *Source) SetHealthy(val bool)
- func (s *Source) SetID(val uint64)
- func (s *Source) SetName(val string)
- func (s *Source) SetTables(val Tables)
- func (s *Source) UnmarshalJSON(data []byte) error
- func (s *Source) Validate() error
- type SourceOptions
- type Sources
- type Table
- func (s *Table) Decode(d *jx.Decoder) error
- func (s *Table) Encode(e *jx.Encoder)
- func (s *Table) GetColumns() []Column
- func (s *Table) GetID() uint64
- func (s *Table) GetName() string
- func (s *Table) GetSchema() string
- func (s *Table) GetSchemaless() bool
- func (s *Table) MarshalJSON() ([]byte, error)
- func (s *Table) SetColumns(val []Column)
- func (s *Table) SetID(val uint64)
- func (s *Table) SetName(val string)
- func (s *Table) SetSchema(val string)
- func (s *Table) SetSchemaless(val bool)
- func (s *Table) UnmarshalJSON(data []byte) error
- func (s *Table) Validate() error
- type Tables
- type UnimplementedHandler
- func (UnimplementedHandler) DeleteCatalog(ctx context.Context, params DeleteCatalogParams) (r DeleteCatalogRes, _ error)
- func (UnimplementedHandler) DeleteNamespace(ctx context.Context, params DeleteNamespaceParams) (r DeleteNamespaceRes, _ error)
- func (UnimplementedHandler) DeleteNamespaceServiceAccount(ctx context.Context, params DeleteNamespaceServiceAccountParams) (r DeleteNamespaceServiceAccountRes, _ error)
- func (UnimplementedHandler) DeleteSource(ctx context.Context, params DeleteSourceParams) (r DeleteSourceRes, _ error)
- func (UnimplementedHandler) DeleteUser(ctx context.Context, params DeleteUserParams) (r DeleteUserRes, _ error)
- func (UnimplementedHandler) FetchSource(ctx context.Context, params FetchSourceParams) (r FetchSourceRes, _ error)
- func (UnimplementedHandler) GetAllNamespaces(ctx context.Context) (r GetAllNamespacesRes, _ error)
- func (UnimplementedHandler) GetCatalog(ctx context.Context, params GetCatalogParams) (r GetCatalogRes, _ error)
- func (UnimplementedHandler) GetCatalogs(ctx context.Context, params GetCatalogsParams) (r Catalogs, _ error)
- func (UnimplementedHandler) GetCluster(ctx context.Context) (r GetClusterRes, _ error)
- func (UnimplementedHandler) GetNamespaceServiceAccount(ctx context.Context, params GetNamespaceServiceAccountParams) (r GetNamespaceServiceAccountRes, _ error)
- func (UnimplementedHandler) GetNamespaceServiceAccounts(ctx context.Context, params GetNamespaceServiceAccountsParams) (r GetNamespaceServiceAccountsRes, _ error)
- func (UnimplementedHandler) GetSource(ctx context.Context, params GetSourceParams) (r GetSourceRes, _ error)
- func (UnimplementedHandler) GetSourceOptions(ctx context.Context, params GetSourceOptionsParams) (r GetSourceOptionsRes, _ error)
- func (UnimplementedHandler) GetSources(ctx context.Context, params GetSourcesParams) (r GetSourcesRes, _ error)
- func (UnimplementedHandler) GetUser(ctx context.Context, params GetUserParams) (r GetUserRes, _ error)
- func (UnimplementedHandler) NewCatalog(ctx context.Context, req *UpsertCatalog, params NewCatalogParams) (r NewCatalogRes, _ error)
- func (UnimplementedHandler) NewNamespace(ctx context.Context, req *NewNamespace) (r NewNamespaceRes, _ error)
- func (UnimplementedHandler) NewNamespaceServiceAccount(ctx context.Context, req *NewServiceAccount, ...) (r NewNamespaceServiceAccountRes, _ error)
- func (UnimplementedHandler) NewSource(ctx context.Context, req *NewSource, params NewSourceParams) (r NewSourceRes, _ error)
- func (UnimplementedHandler) NewUser(ctx context.Context, req *NewUser) (r *User, _ error)
- func (UnimplementedHandler) Query(ctx context.Context, params QueryParams) (r QueryRes, _ error)
- func (UnimplementedHandler) UpdateCatalog(ctx context.Context, req *UpsertCatalog, params UpdateCatalogParams) (r UpdateCatalogRes, _ error)
- type UpdateCatalogParams
- type UpdateCatalogRes
- type UpsertCatalog
- func (s *UpsertCatalog) Decode(d *jx.Decoder) error
- func (s *UpsertCatalog) Encode(e *jx.Encoder)
- func (s *UpsertCatalog) GetDescription() string
- func (s *UpsertCatalog) GetLabels() []string
- func (s *UpsertCatalog) GetName() string
- func (s *UpsertCatalog) GetTables() []UpsertTable
- func (s *UpsertCatalog) MarshalJSON() ([]byte, error)
- func (s *UpsertCatalog) SetDescription(val string)
- func (s *UpsertCatalog) SetLabels(val []string)
- func (s *UpsertCatalog) SetName(val string)
- func (s *UpsertCatalog) SetTables(val []UpsertTable)
- func (s *UpsertCatalog) UnmarshalJSON(data []byte) error
- func (s *UpsertCatalog) Validate() error
- type UpsertTable
- func (s *UpsertTable) Decode(d *jx.Decoder) error
- func (s *UpsertTable) Encode(e *jx.Encoder)
- func (s *UpsertTable) GetID() uint64
- func (s *UpsertTable) GetName() string
- func (s *UpsertTable) GetSchema() string
- func (s *UpsertTable) MarshalJSON() ([]byte, error)
- func (s *UpsertTable) SetID(val uint64)
- func (s *UpsertTable) SetName(val string)
- func (s *UpsertTable) SetSchema(val string)
- func (s *UpsertTable) UnmarshalJSON(data []byte) error
- type User
- func (s *User) Decode(d *jx.Decoder) error
- func (s *User) Encode(e *jx.Encoder)
- func (s *User) GetEmail() string
- func (s *User) GetFullName() string
- func (s *User) GetID() uint64
- func (s *User) GetUsername() string
- func (s *User) MarshalJSON() ([]byte, error)
- func (s *User) SetEmail(val string)
- func (s *User) SetFullName(val string)
- func (s *User) SetID(val uint64)
- func (s *User) SetUsername(val string)
- func (s *User) UnmarshalJSON(data []byte) error
- func (s *User) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Catalog ¶
type Catalog struct { ID uint64 `json:"id"` Name string `json:"name"` Description string `json:"description"` Labels []string `json:"labels"` Tables Tables `json:"tables"` }
Ref: #/components/schemas/Catalog
func (*Catalog) GetDescription ¶
GetDescription returns the value of Description.
func (*Catalog) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Catalog) SetDescription ¶
SetDescription sets the value of Description.
func (*Catalog) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Catalogs ¶
type Catalogs []Catalog
func (Catalogs) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Catalogs) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client implements OAS client.
func NewClient ¶
func NewClient(serverURL string, opts ...ClientOption) (*Client, error)
NewClient initializes new Client defined by OAS.
func (*Client) DeleteCatalog ¶
func (c *Client) DeleteCatalog(ctx context.Context, params DeleteCatalogParams) (DeleteCatalogRes, error)
DeleteCatalog invokes deleteCatalog operation.
Delete a single catalog.
DELETE /v1/namespace/{namespace}/catalog/{catalog}
func (*Client) DeleteNamespace ¶
func (c *Client) DeleteNamespace(ctx context.Context, params DeleteNamespaceParams) (DeleteNamespaceRes, error)
DeleteNamespace invokes deleteNamespace operation.
Delete a single namespace.
DELETE /v1/namespace/{namespace}
func (*Client) DeleteNamespaceServiceAccount ¶
func (c *Client) DeleteNamespaceServiceAccount(ctx context.Context, params DeleteNamespaceServiceAccountParams) (DeleteNamespaceServiceAccountRes, error)
DeleteNamespaceServiceAccount invokes deleteNamespaceServiceAccount operation.
Delete a single service account registered within the given namespace.
DELETE /v1/namespace/{namespace}/service_account/{service_id}
func (*Client) DeleteSource ¶
func (c *Client) DeleteSource(ctx context.Context, params DeleteSourceParams) (DeleteSourceRes, error)
DeleteSource invokes deleteSource operation.
Delete a single catalog source.
DELETE /v1/namespace/{namespace}/source/{source}
func (*Client) DeleteUser ¶
func (c *Client) DeleteUser(ctx context.Context, params DeleteUserParams) (DeleteUserRes, error)
DeleteUser invokes deleteUser operation.
Delete a single user.
DELETE /v1/user/{id}
func (*Client) FetchSource ¶
func (c *Client) FetchSource(ctx context.Context, params FetchSourceParams) (FetchSourceRes, error)
FetchSource invokes fetchSource operation.
Fetch the latest source tables and schemas and update the internal definitions.
GET /v1/namespace/{namespace}/source/{source}/fetch
func (*Client) GetAllNamespaces ¶
func (c *Client) GetAllNamespaces(ctx context.Context) (GetAllNamespacesRes, error)
GetAllNamespaces invokes getAllNamespaces operation.
Retreive all namespaces that the given user is part of.
GET /v1/namespaces
func (*Client) GetCatalog ¶
func (c *Client) GetCatalog(ctx context.Context, params GetCatalogParams) (GetCatalogRes, error)
GetCatalog invokes getCatalog operation.
Fetch all data sets within a given catalog.
GET /v1/namespace/{namespace}/catalog/{catalog}
func (*Client) GetCatalogs ¶
GetCatalogs invokes getCatalogs operation.
Fetches all configured catalogs.
GET /v1/namespace/{namespace}/catalogs
func (*Client) GetCluster ¶
func (c *Client) GetCluster(ctx context.Context) (GetClusterRes, error)
GetCluster invokes getCluster operation.
Get information about the current cluster.
GET /v1/cluster
func (*Client) GetNamespaceServiceAccount ¶
func (c *Client) GetNamespaceServiceAccount(ctx context.Context, params GetNamespaceServiceAccountParams) (GetNamespaceServiceAccountRes, error)
GetNamespaceServiceAccount invokes getNamespaceServiceAccount operation.
Get a single service account registered within the given namespace.
GET /v1/namespace/{namespace}/service_account/{service_id}
func (*Client) GetNamespaceServiceAccounts ¶
func (c *Client) GetNamespaceServiceAccounts(ctx context.Context, params GetNamespaceServiceAccountsParams) (GetNamespaceServiceAccountsRes, error)
GetNamespaceServiceAccounts invokes getNamespaceServiceAccounts operation.
Retreive all service accounts registered within the given namespace.
GET /v1/namespace/{namespace}/service_accounts
func (*Client) GetSource ¶
func (c *Client) GetSource(ctx context.Context, params GetSourceParams) (GetSourceRes, error)
GetSource invokes getSource operation.
Retreive the source details within the a given catalog matching the given source id.
GET /v1/namespace/{namespace}/source/{source}
func (*Client) GetSourceOptions ¶
func (c *Client) GetSourceOptions(ctx context.Context, params GetSourceOptionsParams) (GetSourceOptionsRes, error)
GetSourceOptions invokes getSourceOptions operation.
Retreive the source options within the a given catalog matching the given source id.
GET /v1/namespace/{namespace}/source/{source}/options
func (*Client) GetSources ¶
func (c *Client) GetSources(ctx context.Context, params GetSourcesParams) (GetSourcesRes, error)
GetSources invokes getSources operation.
Fetch all sources within a given catalog.
GET /v1/namespace/{namespace}/sources
func (*Client) GetUser ¶
func (c *Client) GetUser(ctx context.Context, params GetUserParams) (GetUserRes, error)
GetUser invokes getUser operation.
Get a user matching the given id.
GET /v1/user/{id}
func (*Client) NewCatalog ¶
func (c *Client) NewCatalog(ctx context.Context, request *UpsertCatalog, params NewCatalogParams) (NewCatalogRes, error)
NewCatalog invokes newCatalog operation.
Create a new catalog using the given parameters.
POST /v1/namespace/{namespace}/catalog
func (*Client) NewNamespace ¶
func (c *Client) NewNamespace(ctx context.Context, request *NewNamespace) (NewNamespaceRes, error)
NewNamespace invokes newNamespace operation.
Create a new namespace within the cluster.
POST /v1/namespace
func (*Client) NewNamespaceServiceAccount ¶
func (c *Client) NewNamespaceServiceAccount(ctx context.Context, request *NewServiceAccount, params NewNamespaceServiceAccountParams) (NewNamespaceServiceAccountRes, error)
NewNamespaceServiceAccount invokes newNamespaceServiceAccount operation.
Add a new service account to the given namespace.
POST /v1/namespace/{namespace}/service_account
func (*Client) NewSource ¶
func (c *Client) NewSource(ctx context.Context, request *NewSource, params NewSourceParams) (NewSourceRes, error)
NewSource invokes newSource operation.
Create a new catalog source using the given parameters.
POST /v1/namespace/{namespace}/source
func (*Client) NewUser ¶
NewUser invokes newUser operation.
Create a user account within the cluster.
POST /v1/user
func (*Client) Query ¶
Query invokes query operation.
Interact with the configured underlying data catalogs using SQL.
GET /v1/namespace/{namespace}/query
func (*Client) UpdateCatalog ¶
func (c *Client) UpdateCatalog(ctx context.Context, request *UpsertCatalog, params UpdateCatalogParams) (UpdateCatalogRes, error)
UpdateCatalog invokes updateCatalog operation.
Attempts to add the given dataset to the given catalog.
PUT /v1/namespace/{namespace}/catalog/{catalog}
type ClientOption ¶
type ClientOption interface {
// contains filtered or unexported methods
}
ClientOption is client config option.
func WithClient ¶
func WithClient(client ht.Client) ClientOption
WithClient specifies http client to use.
type Cluster ¶
type Cluster struct { Leader uint64 `json:"leader"` Healthy bool `json:"healthy"` Nodes []Node `json:"nodes"` }
Ref: #/components/schemas/Cluster
func (*Cluster) GetHealthy ¶
GetHealthy returns the value of Healthy.
func (*Cluster) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Cluster) SetHealthy ¶
SetHealthy sets the value of Healthy.
func (*Cluster) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Column ¶
type Column struct { ID uint64 `json:"id"` Name string `json:"name"` Type string `json:"type"` Cap uint64 `json:"cap"` Nullable bool `json:"nullable"` }
Ref: #/components/schemas/Column
func (*Column) GetNullable ¶
GetNullable returns the value of Nullable.
func (*Column) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Column) SetNullable ¶
SetNullable sets the value of Nullable.
func (*Column) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type DeleteCatalogOK ¶
type DeleteCatalogOK struct{}
DeleteCatalogOK is response for DeleteCatalog operation.
type DeleteCatalogParams ¶
type DeleteCatalogParams struct { // Unique namespace identifier. Namespace string // Unique catalog identifier. Catalog string }
DeleteCatalogParams is parameters of deleteCatalog operation.
type DeleteCatalogRes ¶
type DeleteCatalogRes interface {
// contains filtered or unexported methods
}
type DeleteNamespaceOK ¶
type DeleteNamespaceOK struct{}
DeleteNamespaceOK is response for DeleteNamespace operation.
type DeleteNamespaceParams ¶
type DeleteNamespaceParams struct { // Unique namespace identifier. Namespace string }
DeleteNamespaceParams is parameters of deleteNamespace operation.
type DeleteNamespaceRes ¶
type DeleteNamespaceRes interface {
// contains filtered or unexported methods
}
type DeleteNamespaceServiceAccountOK ¶
type DeleteNamespaceServiceAccountOK struct{}
DeleteNamespaceServiceAccountOK is response for DeleteNamespaceServiceAccount operation.
type DeleteNamespaceServiceAccountParams ¶
type DeleteNamespaceServiceAccountParams struct { // Unique namespace identifier. Namespace string // Unique service account identifier. ServiceID uint64 }
DeleteNamespaceServiceAccountParams is parameters of deleteNamespaceServiceAccount operation.
type DeleteNamespaceServiceAccountRes ¶
type DeleteNamespaceServiceAccountRes interface {
// contains filtered or unexported methods
}
type DeleteSourceOK ¶
type DeleteSourceOK struct{}
DeleteSourceOK is response for DeleteSource operation.
type DeleteSourceParams ¶
type DeleteSourceParams struct { // Unique namespace identifier. Namespace string // Unique source identifier. Source string }
DeleteSourceParams is parameters of deleteSource operation.
type DeleteSourceRes ¶
type DeleteSourceRes interface {
// contains filtered or unexported methods
}
type DeleteUserParams ¶
type DeleteUserParams struct { // Unique user identifier. ID uint64 }
DeleteUserParams is parameters of deleteUser operation.
type DeleteUserRes ¶
type DeleteUserRes interface {
// contains filtered or unexported methods
}
type FetchSourceParams ¶
type FetchSourceParams struct { // Unique namespace identifier. Namespace string // Unique source identifier. Source string }
FetchSourceParams is parameters of fetchSource operation.
type FetchSourceRes ¶
type FetchSourceRes interface {
// contains filtered or unexported methods
}
type GetAllNamespacesRes ¶
type GetAllNamespacesRes interface {
// contains filtered or unexported methods
}
type GetCatalogParams ¶
type GetCatalogParams struct { // Unique namespace identifier. Namespace string // Unique catalog identifier. Catalog string }
GetCatalogParams is parameters of getCatalog operation.
type GetCatalogRes ¶
type GetCatalogRes interface {
// contains filtered or unexported methods
}
type GetCatalogsParams ¶
type GetCatalogsParams struct { // Unique namespace identifier. Namespace string }
GetCatalogsParams is parameters of getCatalogs operation.
type GetClusterRes ¶
type GetClusterRes interface {
// contains filtered or unexported methods
}
type GetNamespaceServiceAccountParams ¶
type GetNamespaceServiceAccountParams struct { // Unique namespace identifier. Namespace string // Unique service account identifier. ServiceID uint64 }
GetNamespaceServiceAccountParams is parameters of getNamespaceServiceAccount operation.
type GetNamespaceServiceAccountRes ¶
type GetNamespaceServiceAccountRes interface {
// contains filtered or unexported methods
}
type GetNamespaceServiceAccountsParams ¶
type GetNamespaceServiceAccountsParams struct { // Unique namespace identifier. Namespace string }
GetNamespaceServiceAccountsParams is parameters of getNamespaceServiceAccounts operation.
type GetNamespaceServiceAccountsRes ¶
type GetNamespaceServiceAccountsRes interface {
// contains filtered or unexported methods
}
type GetSourceNotFound ¶
type GetSourceNotFound Problem
func (*GetSourceNotFound) Decode ¶
func (s *GetSourceNotFound) Decode(d *jx.Decoder) error
Decode decodes GetSourceNotFound from json.
func (*GetSourceNotFound) Encode ¶
func (s *GetSourceNotFound) Encode(e *jx.Encoder)
Encode encodes GetSourceNotFound as json.
func (*GetSourceNotFound) MarshalJSON ¶
func (s *GetSourceNotFound) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*GetSourceNotFound) UnmarshalJSON ¶
func (s *GetSourceNotFound) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
type GetSourceOptionsParams ¶
type GetSourceOptionsParams struct { // Unique namespace identifier. Namespace string // Unique source identifier. Source string }
GetSourceOptionsParams is parameters of getSourceOptions operation.
type GetSourceOptionsRes ¶
type GetSourceOptionsRes interface {
// contains filtered or unexported methods
}
type GetSourceParams ¶
type GetSourceParams struct { // Unique namespace identifier. Namespace string // Unique source identifier. Source string }
GetSourceParams is parameters of getSource operation.
type GetSourceRes ¶
type GetSourceRes interface {
// contains filtered or unexported methods
}
type GetSourceUnauthorized ¶
type GetSourceUnauthorized Problem
func (*GetSourceUnauthorized) Decode ¶
func (s *GetSourceUnauthorized) Decode(d *jx.Decoder) error
Decode decodes GetSourceUnauthorized from json.
func (*GetSourceUnauthorized) Encode ¶
func (s *GetSourceUnauthorized) Encode(e *jx.Encoder)
Encode encodes GetSourceUnauthorized as json.
func (*GetSourceUnauthorized) MarshalJSON ¶
func (s *GetSourceUnauthorized) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*GetSourceUnauthorized) UnmarshalJSON ¶
func (s *GetSourceUnauthorized) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
type GetSourcesParams ¶
type GetSourcesParams struct { // Unique namespace identifier. Namespace string }
GetSourcesParams is parameters of getSources operation.
type GetSourcesRes ¶
type GetSourcesRes interface {
// contains filtered or unexported methods
}
type GetUserParams ¶
type GetUserParams struct { // Unique user identifier. ID uint64 }
GetUserParams is parameters of getUser operation.
type GetUserRes ¶
type GetUserRes interface {
// contains filtered or unexported methods
}
type Handler ¶
type Handler interface { // DeleteCatalog implements deleteCatalog operation. // // Delete a single catalog. // // DELETE /v1/namespace/{namespace}/catalog/{catalog} DeleteCatalog(ctx context.Context, params DeleteCatalogParams) (DeleteCatalogRes, error) // DeleteNamespace implements deleteNamespace operation. // // Delete a single namespace. // // DELETE /v1/namespace/{namespace} DeleteNamespace(ctx context.Context, params DeleteNamespaceParams) (DeleteNamespaceRes, error) // DeleteNamespaceServiceAccount implements deleteNamespaceServiceAccount operation. // // Delete a single service account registered within the given namespace. // // DELETE /v1/namespace/{namespace}/service_account/{service_id} DeleteNamespaceServiceAccount(ctx context.Context, params DeleteNamespaceServiceAccountParams) (DeleteNamespaceServiceAccountRes, error) // DeleteSource implements deleteSource operation. // // Delete a single catalog source. // // DELETE /v1/namespace/{namespace}/source/{source} DeleteSource(ctx context.Context, params DeleteSourceParams) (DeleteSourceRes, error) // DeleteUser implements deleteUser operation. // // Delete a single user. // // DELETE /v1/user/{id} DeleteUser(ctx context.Context, params DeleteUserParams) (DeleteUserRes, error) // FetchSource implements fetchSource operation. // // Fetch the latest source tables and schemas and update the internal definitions. // // GET /v1/namespace/{namespace}/source/{source}/fetch FetchSource(ctx context.Context, params FetchSourceParams) (FetchSourceRes, error) // GetAllNamespaces implements getAllNamespaces operation. // // Retreive all namespaces that the given user is part of. // // GET /v1/namespaces GetAllNamespaces(ctx context.Context) (GetAllNamespacesRes, error) // GetCatalog implements getCatalog operation. // // Fetch all data sets within a given catalog. // // GET /v1/namespace/{namespace}/catalog/{catalog} GetCatalog(ctx context.Context, params GetCatalogParams) (GetCatalogRes, error) // GetCatalogs implements getCatalogs operation. // // Fetches all configured catalogs. // // GET /v1/namespace/{namespace}/catalogs GetCatalogs(ctx context.Context, params GetCatalogsParams) (Catalogs, error) // GetCluster implements getCluster operation. // // Get information about the current cluster. // // GET /v1/cluster GetCluster(ctx context.Context) (GetClusterRes, error) // GetNamespaceServiceAccount implements getNamespaceServiceAccount operation. // // Get a single service account registered within the given namespace. // // GET /v1/namespace/{namespace}/service_account/{service_id} GetNamespaceServiceAccount(ctx context.Context, params GetNamespaceServiceAccountParams) (GetNamespaceServiceAccountRes, error) // GetNamespaceServiceAccounts implements getNamespaceServiceAccounts operation. // // Retreive all service accounts registered within the given namespace. // // GET /v1/namespace/{namespace}/service_accounts GetNamespaceServiceAccounts(ctx context.Context, params GetNamespaceServiceAccountsParams) (GetNamespaceServiceAccountsRes, error) // GetSource implements getSource operation. // // Retreive the source details within the a given catalog matching the given source id. // // GET /v1/namespace/{namespace}/source/{source} GetSource(ctx context.Context, params GetSourceParams) (GetSourceRes, error) // GetSourceOptions implements getSourceOptions operation. // // Retreive the source options within the a given catalog matching the given source id. // // GET /v1/namespace/{namespace}/source/{source}/options GetSourceOptions(ctx context.Context, params GetSourceOptionsParams) (GetSourceOptionsRes, error) // GetSources implements getSources operation. // // Fetch all sources within a given catalog. // // GET /v1/namespace/{namespace}/sources GetSources(ctx context.Context, params GetSourcesParams) (GetSourcesRes, error) // GetUser implements getUser operation. // // Get a user matching the given id. // // GET /v1/user/{id} GetUser(ctx context.Context, params GetUserParams) (GetUserRes, error) // NewCatalog implements newCatalog operation. // // Create a new catalog using the given parameters. // // POST /v1/namespace/{namespace}/catalog NewCatalog(ctx context.Context, req *UpsertCatalog, params NewCatalogParams) (NewCatalogRes, error) // NewNamespace implements newNamespace operation. // // Create a new namespace within the cluster. // // POST /v1/namespace NewNamespace(ctx context.Context, req *NewNamespace) (NewNamespaceRes, error) // NewNamespaceServiceAccount implements newNamespaceServiceAccount operation. // // Add a new service account to the given namespace. // // POST /v1/namespace/{namespace}/service_account NewNamespaceServiceAccount(ctx context.Context, req *NewServiceAccount, params NewNamespaceServiceAccountParams) (NewNamespaceServiceAccountRes, error) // NewSource implements newSource operation. // // Create a new catalog source using the given parameters. // // POST /v1/namespace/{namespace}/source NewSource(ctx context.Context, req *NewSource, params NewSourceParams) (NewSourceRes, error) // NewUser implements newUser operation. // // Create a user account within the cluster. // // POST /v1/user NewUser(ctx context.Context, req *NewUser) (*User, error) // Query implements query operation. // // Interact with the configured underlying data catalogs using SQL. // // GET /v1/namespace/{namespace}/query Query(ctx context.Context, params QueryParams) (QueryRes, error) // UpdateCatalog implements updateCatalog operation. // // Attempts to add the given dataset to the given catalog. // // PUT /v1/namespace/{namespace}/catalog/{catalog} UpdateCatalog(ctx context.Context, req *UpsertCatalog, params UpdateCatalogParams) (UpdateCatalogRes, error) }
Handler handles operations described by OpenAPI v3 specification.
type Namespace ¶
type Namespace struct {
Name string `json:"name"`
}
Ref: #/components/schemas/Namespace
func (*Namespace) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Namespace) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Namespaces ¶
type Namespaces []Namespace
func (*Namespaces) Decode ¶
func (s *Namespaces) Decode(d *jx.Decoder) error
Decode decodes Namespaces from json.
func (Namespaces) Encode ¶
func (s Namespaces) Encode(e *jx.Encoder)
Encode encodes Namespaces as json.
func (Namespaces) MarshalJSON ¶
func (s Namespaces) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*Namespaces) UnmarshalJSON ¶
func (s *Namespaces) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
func (Namespaces) Validate ¶
func (s Namespaces) Validate() error
type NewCatalogParams ¶
type NewCatalogParams struct { // Unique namespace identifier. Namespace string }
NewCatalogParams is parameters of newCatalog operation.
type NewCatalogRes ¶
type NewCatalogRes interface {
// contains filtered or unexported methods
}
type NewNamespace ¶
type NewNamespace struct {
Name string `json:"name"`
}
Ref: #/components/schemas/NewNamespace
func (*NewNamespace) Decode ¶
func (s *NewNamespace) Decode(d *jx.Decoder) error
Decode decodes NewNamespace from json.
func (*NewNamespace) Encode ¶
func (s *NewNamespace) Encode(e *jx.Encoder)
Encode implements json.Marshaler.
func (*NewNamespace) GetName ¶
func (s *NewNamespace) GetName() string
GetName returns the value of Name.
func (*NewNamespace) MarshalJSON ¶
func (s *NewNamespace) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*NewNamespace) SetName ¶
func (s *NewNamespace) SetName(val string)
SetName sets the value of Name.
func (*NewNamespace) UnmarshalJSON ¶
func (s *NewNamespace) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
type NewNamespaceRes ¶
type NewNamespaceRes interface {
// contains filtered or unexported methods
}
type NewNamespaceServiceAccountParams ¶
type NewNamespaceServiceAccountParams struct { // Unique namespace identifier. Namespace string }
NewNamespaceServiceAccountParams is parameters of newNamespaceServiceAccount operation.
type NewNamespaceServiceAccountRes ¶
type NewNamespaceServiceAccountRes interface {
// contains filtered or unexported methods
}
type NewServiceAccount ¶
type NewServiceAccount struct { Principal OptString `json:"principal"` Name string `json:"name"` Description string `json:"description"` Labels []string `json:"labels"` }
Ref: #/components/schemas/NewServiceAccount
func (*NewServiceAccount) Decode ¶
func (s *NewServiceAccount) Decode(d *jx.Decoder) error
Decode decodes NewServiceAccount from json.
func (*NewServiceAccount) Encode ¶
func (s *NewServiceAccount) Encode(e *jx.Encoder)
Encode implements json.Marshaler.
func (*NewServiceAccount) GetDescription ¶
func (s *NewServiceAccount) GetDescription() string
GetDescription returns the value of Description.
func (*NewServiceAccount) GetLabels ¶
func (s *NewServiceAccount) GetLabels() []string
GetLabels returns the value of Labels.
func (*NewServiceAccount) GetName ¶
func (s *NewServiceAccount) GetName() string
GetName returns the value of Name.
func (*NewServiceAccount) GetPrincipal ¶
func (s *NewServiceAccount) GetPrincipal() OptString
GetPrincipal returns the value of Principal.
func (*NewServiceAccount) MarshalJSON ¶
func (s *NewServiceAccount) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*NewServiceAccount) SetDescription ¶
func (s *NewServiceAccount) SetDescription(val string)
SetDescription sets the value of Description.
func (*NewServiceAccount) SetLabels ¶
func (s *NewServiceAccount) SetLabels(val []string)
SetLabels sets the value of Labels.
func (*NewServiceAccount) SetName ¶
func (s *NewServiceAccount) SetName(val string)
SetName sets the value of Name.
func (*NewServiceAccount) SetPrincipal ¶
func (s *NewServiceAccount) SetPrincipal(val OptString)
SetPrincipal sets the value of Principal.
func (*NewServiceAccount) UnmarshalJSON ¶
func (s *NewServiceAccount) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
func (*NewServiceAccount) Validate ¶
func (s *NewServiceAccount) Validate() error
type NewSource ¶
type NewSource struct { Name string `json:"name"` // Represents the connector name used to connect with the given source. Connector string `json:"connector"` Options SourceOptions `json:"options"` }
Ref: #/components/schemas/NewSource
func (*NewSource) GetConnector ¶
GetConnector returns the value of Connector.
func (*NewSource) GetOptions ¶
func (s *NewSource) GetOptions() SourceOptions
GetOptions returns the value of Options.
func (*NewSource) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*NewSource) SetConnector ¶
SetConnector sets the value of Connector.
func (*NewSource) SetOptions ¶
func (s *NewSource) SetOptions(val SourceOptions)
SetOptions sets the value of Options.
func (*NewSource) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type NewSourceParams ¶
type NewSourceParams struct { // Unique namespace identifier. Namespace string }
NewSourceParams is parameters of newSource operation.
type NewSourceRes ¶
type NewSourceRes interface {
// contains filtered or unexported methods
}
type NewUser ¶
type NewUser struct { FullName string `json:"full_name"` Username string `json:"username"` Email string `json:"email"` Password string `json:"password"` }
Ref: #/components/schemas/NewUser
func (*NewUser) GetFullName ¶
GetFullName returns the value of FullName.
func (*NewUser) GetPassword ¶
GetPassword returns the value of Password.
func (*NewUser) GetUsername ¶
GetUsername returns the value of Username.
func (*NewUser) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*NewUser) SetFullName ¶
SetFullName sets the value of FullName.
func (*NewUser) SetPassword ¶
SetPassword sets the value of Password.
func (*NewUser) SetUsername ¶
SetUsername sets the value of Username.
func (*NewUser) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Node ¶
type Node struct { ID uint64 `json:"id"` Address string `json:"address"` Healthy bool `json:"healthy"` Ready bool `json:"ready"` }
Ref: #/components/schemas/Node
func (*Node) GetAddress ¶
GetAddress returns the value of Address.
func (*Node) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Node) SetAddress ¶
SetAddress sets the value of Address.
func (*Node) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type OptString ¶
OptString is optional string.
func NewOptString ¶
NewOptString returns new OptString with value set to v.
func (OptString) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*OptString) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Option ¶
type Option interface { ServerOption ClientOption }
Option is config option.
func WithMeterProvider ¶
func WithMeterProvider(provider metric.MeterProvider) Option
WithMeterProvider specifies a meter provider to use for creating a meter.
If none is specified, the otel.GetMeterProvider() is used.
func WithTracerProvider ¶
func WithTracerProvider(provider trace.TracerProvider) Option
WithTracerProvider specifies a tracer provider to use for creating a tracer.
If none is specified, the global provider is used.
type Problem ¶
type Problem struct { // A short summary of the problem type. Written in English and readable for engineers, usually not // suited for non technical stakeholders and not localized. Title string `json:"title"` // A human readable explanation specific to this occurrence of the problem that is helpful to locate // the problem and give advice on how to proceed. Written in English and readable for engineers, // usually not suited for non technical stakeholders and not localized. Detail string `json:"detail"` }
Ref: #/components/schemas/Problem
func (*Problem) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Problem) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type QueryBadRequest ¶
type QueryBadRequest Problem
func (*QueryBadRequest) Decode ¶
func (s *QueryBadRequest) Decode(d *jx.Decoder) error
Decode decodes QueryBadRequest from json.
func (*QueryBadRequest) Encode ¶
func (s *QueryBadRequest) Encode(e *jx.Encoder)
Encode encodes QueryBadRequest as json.
func (*QueryBadRequest) MarshalJSON ¶
func (s *QueryBadRequest) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*QueryBadRequest) UnmarshalJSON ¶
func (s *QueryBadRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
type QueryParams ¶
type QueryParams struct { // Unique namespace identifier. Namespace string // SQL query statements to be executed. Statements string }
QueryParams is parameters of query operation.
type QueryUnauthorized ¶
type QueryUnauthorized Problem
func (*QueryUnauthorized) Decode ¶
func (s *QueryUnauthorized) Decode(d *jx.Decoder) error
Decode decodes QueryUnauthorized from json.
func (*QueryUnauthorized) Encode ¶
func (s *QueryUnauthorized) Encode(e *jx.Encoder)
Encode encodes QueryUnauthorized as json.
func (*QueryUnauthorized) MarshalJSON ¶
func (s *QueryUnauthorized) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*QueryUnauthorized) UnmarshalJSON ¶
func (s *QueryUnauthorized) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
type Route ¶
type Route struct {
// contains filtered or unexported fields
}
Route is route object.
func (Route) OperationID ¶
OperationID returns OpenAPI operationId.
type Rows ¶
Ref: #/components/schemas/Rows
func (*Rows) GetColumns ¶
GetColumns returns the value of Columns.
func (*Rows) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Rows) SetColumns ¶
SetColumns sets the value of Columns.
func (*Rows) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.
func NewServer ¶
func NewServer(h Handler, opts ...ServerOption) (*Server, error)
NewServer creates new Server.
type ServerOption ¶
type ServerOption interface {
// contains filtered or unexported methods
}
ServerOption is server config option.
func WithErrorHandler ¶
func WithErrorHandler(h ErrorHandler) ServerOption
WithErrorHandler specifies error handler to use.
func WithMaxMultipartMemory ¶
func WithMaxMultipartMemory(max int64) ServerOption
WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.
func WithMethodNotAllowed ¶
func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption
WithMethodNotAllowed specifies Method Not Allowed handler to use.
func WithMiddleware ¶
func WithMiddleware(m ...Middleware) ServerOption
WithMiddleware specifies middlewares to use.
func WithNotFound ¶
func WithNotFound(notFound http.HandlerFunc) ServerOption
WithNotFound specifies Not Found handler to use.
func WithPathPrefix ¶
func WithPathPrefix(prefix string) ServerOption
WithPathPrefix specifies server path prefix.
type ServiceAccount ¶
type ServiceAccount struct { Principal string `json:"principal"` Name string `json:"name"` Description string `json:"description"` Labels []string `json:"labels"` }
Ref: #/components/schemas/ServiceAccount
func (*ServiceAccount) Decode ¶
func (s *ServiceAccount) Decode(d *jx.Decoder) error
Decode decodes ServiceAccount from json.
func (*ServiceAccount) Encode ¶
func (s *ServiceAccount) Encode(e *jx.Encoder)
Encode implements json.Marshaler.
func (*ServiceAccount) GetDescription ¶
func (s *ServiceAccount) GetDescription() string
GetDescription returns the value of Description.
func (*ServiceAccount) GetLabels ¶
func (s *ServiceAccount) GetLabels() []string
GetLabels returns the value of Labels.
func (*ServiceAccount) GetName ¶
func (s *ServiceAccount) GetName() string
GetName returns the value of Name.
func (*ServiceAccount) GetPrincipal ¶
func (s *ServiceAccount) GetPrincipal() string
GetPrincipal returns the value of Principal.
func (*ServiceAccount) MarshalJSON ¶
func (s *ServiceAccount) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*ServiceAccount) SetDescription ¶
func (s *ServiceAccount) SetDescription(val string)
SetDescription sets the value of Description.
func (*ServiceAccount) SetLabels ¶
func (s *ServiceAccount) SetLabels(val []string)
SetLabels sets the value of Labels.
func (*ServiceAccount) SetName ¶
func (s *ServiceAccount) SetName(val string)
SetName sets the value of Name.
func (*ServiceAccount) SetPrincipal ¶
func (s *ServiceAccount) SetPrincipal(val string)
SetPrincipal sets the value of Principal.
func (*ServiceAccount) UnmarshalJSON ¶
func (s *ServiceAccount) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
func (*ServiceAccount) Validate ¶
func (s *ServiceAccount) Validate() error
type ServiceAccounts ¶
type ServiceAccounts []ServiceAccount
func (*ServiceAccounts) Decode ¶
func (s *ServiceAccounts) Decode(d *jx.Decoder) error
Decode decodes ServiceAccounts from json.
func (ServiceAccounts) Encode ¶
func (s ServiceAccounts) Encode(e *jx.Encoder)
Encode encodes ServiceAccounts as json.
func (ServiceAccounts) MarshalJSON ¶
func (s ServiceAccounts) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*ServiceAccounts) UnmarshalJSON ¶
func (s *ServiceAccounts) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
func (ServiceAccounts) Validate ¶
func (s ServiceAccounts) Validate() error
type Source ¶
type Source struct { ID uint64 `json:"id"` Name string `json:"name"` // Represents the connector name used to connect with the given source. Connector string `json:"connector"` Healthy bool `json:"healthy"` Tables Tables `json:"tables"` }
Ref: #/components/schemas/Source
func (*Source) GetConnector ¶
GetConnector returns the value of Connector.
func (*Source) GetHealthy ¶
GetHealthy returns the value of Healthy.
func (*Source) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Source) SetConnector ¶
SetConnector sets the value of Connector.
func (*Source) SetHealthy ¶
SetHealthy sets the value of Healthy.
func (*Source) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type SourceOptions ¶
Ref: #/components/schemas/SourceOptions
func (*SourceOptions) Decode ¶
func (s *SourceOptions) Decode(d *jx.Decoder) error
Decode decodes SourceOptions from json.
func (SourceOptions) Encode ¶
func (s SourceOptions) Encode(e *jx.Encoder)
Encode implements json.Marshaler.
func (SourceOptions) MarshalJSON ¶
func (s SourceOptions) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*SourceOptions) UnmarshalJSON ¶
func (s *SourceOptions) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
type Sources ¶
type Sources []Source
func (Sources) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Sources) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Table ¶
type Table struct { ID uint64 `json:"id"` Name string `json:"name"` Schema string `json:"schema"` Schemaless bool `json:"schemaless"` Columns []Column `json:"columns"` }
Ref: #/components/schemas/Table
func (*Table) GetColumns ¶
GetColumns returns the value of Columns.
func (*Table) GetSchemaless ¶
GetSchemaless returns the value of Schemaless.
func (*Table) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Table) SetColumns ¶
SetColumns sets the value of Columns.
func (*Table) SetSchemaless ¶
SetSchemaless sets the value of Schemaless.
func (*Table) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Tables ¶
type Tables []Table
func (Tables) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Tables) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type UnimplementedHandler ¶
type UnimplementedHandler struct{}
UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.
func (UnimplementedHandler) DeleteCatalog ¶
func (UnimplementedHandler) DeleteCatalog(ctx context.Context, params DeleteCatalogParams) (r DeleteCatalogRes, _ error)
DeleteCatalog implements deleteCatalog operation.
Delete a single catalog.
DELETE /v1/namespace/{namespace}/catalog/{catalog}
func (UnimplementedHandler) DeleteNamespace ¶
func (UnimplementedHandler) DeleteNamespace(ctx context.Context, params DeleteNamespaceParams) (r DeleteNamespaceRes, _ error)
DeleteNamespace implements deleteNamespace operation.
Delete a single namespace.
DELETE /v1/namespace/{namespace}
func (UnimplementedHandler) DeleteNamespaceServiceAccount ¶
func (UnimplementedHandler) DeleteNamespaceServiceAccount(ctx context.Context, params DeleteNamespaceServiceAccountParams) (r DeleteNamespaceServiceAccountRes, _ error)
DeleteNamespaceServiceAccount implements deleteNamespaceServiceAccount operation.
Delete a single service account registered within the given namespace.
DELETE /v1/namespace/{namespace}/service_account/{service_id}
func (UnimplementedHandler) DeleteSource ¶
func (UnimplementedHandler) DeleteSource(ctx context.Context, params DeleteSourceParams) (r DeleteSourceRes, _ error)
DeleteSource implements deleteSource operation.
Delete a single catalog source.
DELETE /v1/namespace/{namespace}/source/{source}
func (UnimplementedHandler) DeleteUser ¶
func (UnimplementedHandler) DeleteUser(ctx context.Context, params DeleteUserParams) (r DeleteUserRes, _ error)
DeleteUser implements deleteUser operation.
Delete a single user.
DELETE /v1/user/{id}
func (UnimplementedHandler) FetchSource ¶
func (UnimplementedHandler) FetchSource(ctx context.Context, params FetchSourceParams) (r FetchSourceRes, _ error)
FetchSource implements fetchSource operation.
Fetch the latest source tables and schemas and update the internal definitions.
GET /v1/namespace/{namespace}/source/{source}/fetch
func (UnimplementedHandler) GetAllNamespaces ¶
func (UnimplementedHandler) GetAllNamespaces(ctx context.Context) (r GetAllNamespacesRes, _ error)
GetAllNamespaces implements getAllNamespaces operation.
Retreive all namespaces that the given user is part of.
GET /v1/namespaces
func (UnimplementedHandler) GetCatalog ¶
func (UnimplementedHandler) GetCatalog(ctx context.Context, params GetCatalogParams) (r GetCatalogRes, _ error)
GetCatalog implements getCatalog operation.
Fetch all data sets within a given catalog.
GET /v1/namespace/{namespace}/catalog/{catalog}
func (UnimplementedHandler) GetCatalogs ¶
func (UnimplementedHandler) GetCatalogs(ctx context.Context, params GetCatalogsParams) (r Catalogs, _ error)
GetCatalogs implements getCatalogs operation.
Fetches all configured catalogs.
GET /v1/namespace/{namespace}/catalogs
func (UnimplementedHandler) GetCluster ¶
func (UnimplementedHandler) GetCluster(ctx context.Context) (r GetClusterRes, _ error)
GetCluster implements getCluster operation.
Get information about the current cluster.
GET /v1/cluster
func (UnimplementedHandler) GetNamespaceServiceAccount ¶
func (UnimplementedHandler) GetNamespaceServiceAccount(ctx context.Context, params GetNamespaceServiceAccountParams) (r GetNamespaceServiceAccountRes, _ error)
GetNamespaceServiceAccount implements getNamespaceServiceAccount operation.
Get a single service account registered within the given namespace.
GET /v1/namespace/{namespace}/service_account/{service_id}
func (UnimplementedHandler) GetNamespaceServiceAccounts ¶
func (UnimplementedHandler) GetNamespaceServiceAccounts(ctx context.Context, params GetNamespaceServiceAccountsParams) (r GetNamespaceServiceAccountsRes, _ error)
GetNamespaceServiceAccounts implements getNamespaceServiceAccounts operation.
Retreive all service accounts registered within the given namespace.
GET /v1/namespace/{namespace}/service_accounts
func (UnimplementedHandler) GetSource ¶
func (UnimplementedHandler) GetSource(ctx context.Context, params GetSourceParams) (r GetSourceRes, _ error)
GetSource implements getSource operation.
Retreive the source details within the a given catalog matching the given source id.
GET /v1/namespace/{namespace}/source/{source}
func (UnimplementedHandler) GetSourceOptions ¶
func (UnimplementedHandler) GetSourceOptions(ctx context.Context, params GetSourceOptionsParams) (r GetSourceOptionsRes, _ error)
GetSourceOptions implements getSourceOptions operation.
Retreive the source options within the a given catalog matching the given source id.
GET /v1/namespace/{namespace}/source/{source}/options
func (UnimplementedHandler) GetSources ¶
func (UnimplementedHandler) GetSources(ctx context.Context, params GetSourcesParams) (r GetSourcesRes, _ error)
GetSources implements getSources operation.
Fetch all sources within a given catalog.
GET /v1/namespace/{namespace}/sources
func (UnimplementedHandler) GetUser ¶
func (UnimplementedHandler) GetUser(ctx context.Context, params GetUserParams) (r GetUserRes, _ error)
GetUser implements getUser operation.
Get a user matching the given id.
GET /v1/user/{id}
func (UnimplementedHandler) NewCatalog ¶
func (UnimplementedHandler) NewCatalog(ctx context.Context, req *UpsertCatalog, params NewCatalogParams) (r NewCatalogRes, _ error)
NewCatalog implements newCatalog operation.
Create a new catalog using the given parameters.
POST /v1/namespace/{namespace}/catalog
func (UnimplementedHandler) NewNamespace ¶
func (UnimplementedHandler) NewNamespace(ctx context.Context, req *NewNamespace) (r NewNamespaceRes, _ error)
NewNamespace implements newNamespace operation.
Create a new namespace within the cluster.
POST /v1/namespace
func (UnimplementedHandler) NewNamespaceServiceAccount ¶
func (UnimplementedHandler) NewNamespaceServiceAccount(ctx context.Context, req *NewServiceAccount, params NewNamespaceServiceAccountParams) (r NewNamespaceServiceAccountRes, _ error)
NewNamespaceServiceAccount implements newNamespaceServiceAccount operation.
Add a new service account to the given namespace.
POST /v1/namespace/{namespace}/service_account
func (UnimplementedHandler) NewSource ¶
func (UnimplementedHandler) NewSource(ctx context.Context, req *NewSource, params NewSourceParams) (r NewSourceRes, _ error)
NewSource implements newSource operation.
Create a new catalog source using the given parameters.
POST /v1/namespace/{namespace}/source
func (UnimplementedHandler) NewUser ¶
NewUser implements newUser operation.
Create a user account within the cluster.
POST /v1/user
func (UnimplementedHandler) Query ¶
func (UnimplementedHandler) Query(ctx context.Context, params QueryParams) (r QueryRes, _ error)
Query implements query operation.
Interact with the configured underlying data catalogs using SQL.
GET /v1/namespace/{namespace}/query
func (UnimplementedHandler) UpdateCatalog ¶
func (UnimplementedHandler) UpdateCatalog(ctx context.Context, req *UpsertCatalog, params UpdateCatalogParams) (r UpdateCatalogRes, _ error)
UpdateCatalog implements updateCatalog operation.
Attempts to add the given dataset to the given catalog.
PUT /v1/namespace/{namespace}/catalog/{catalog}
type UpdateCatalogParams ¶
type UpdateCatalogParams struct { // Unique namespace identifier. Namespace string // Unique catalog identifier. Catalog string }
UpdateCatalogParams is parameters of updateCatalog operation.
type UpdateCatalogRes ¶
type UpdateCatalogRes interface {
// contains filtered or unexported methods
}
type UpsertCatalog ¶
type UpsertCatalog struct { // The catalog name referenced within SQL queries. Name string `json:"name"` Description string `json:"description"` Labels []string `json:"labels"` Tables []UpsertTable `json:"tables"` }
Ref: #/components/schemas/UpsertCatalog
func (*UpsertCatalog) Decode ¶
func (s *UpsertCatalog) Decode(d *jx.Decoder) error
Decode decodes UpsertCatalog from json.
func (*UpsertCatalog) Encode ¶
func (s *UpsertCatalog) Encode(e *jx.Encoder)
Encode implements json.Marshaler.
func (*UpsertCatalog) GetDescription ¶
func (s *UpsertCatalog) GetDescription() string
GetDescription returns the value of Description.
func (*UpsertCatalog) GetLabels ¶
func (s *UpsertCatalog) GetLabels() []string
GetLabels returns the value of Labels.
func (*UpsertCatalog) GetName ¶
func (s *UpsertCatalog) GetName() string
GetName returns the value of Name.
func (*UpsertCatalog) GetTables ¶
func (s *UpsertCatalog) GetTables() []UpsertTable
GetTables returns the value of Tables.
func (*UpsertCatalog) MarshalJSON ¶
func (s *UpsertCatalog) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*UpsertCatalog) SetDescription ¶
func (s *UpsertCatalog) SetDescription(val string)
SetDescription sets the value of Description.
func (*UpsertCatalog) SetLabels ¶
func (s *UpsertCatalog) SetLabels(val []string)
SetLabels sets the value of Labels.
func (*UpsertCatalog) SetName ¶
func (s *UpsertCatalog) SetName(val string)
SetName sets the value of Name.
func (*UpsertCatalog) SetTables ¶
func (s *UpsertCatalog) SetTables(val []UpsertTable)
SetTables sets the value of Tables.
func (*UpsertCatalog) UnmarshalJSON ¶
func (s *UpsertCatalog) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
func (*UpsertCatalog) Validate ¶
func (s *UpsertCatalog) Validate() error
type UpsertTable ¶
type UpsertTable struct { ID uint64 `json:"id"` // The table name referenced within SQL queries. Name string `json:"name"` // The table schema referenced within SQL queries. Schema string `json:"schema"` }
Ref: #/components/schemas/UpsertTable
func (*UpsertTable) Decode ¶
func (s *UpsertTable) Decode(d *jx.Decoder) error
Decode decodes UpsertTable from json.
func (*UpsertTable) Encode ¶
func (s *UpsertTable) Encode(e *jx.Encoder)
Encode implements json.Marshaler.
func (*UpsertTable) GetName ¶
func (s *UpsertTable) GetName() string
GetName returns the value of Name.
func (*UpsertTable) GetSchema ¶
func (s *UpsertTable) GetSchema() string
GetSchema returns the value of Schema.
func (*UpsertTable) MarshalJSON ¶
func (s *UpsertTable) MarshalJSON() ([]byte, error)
MarshalJSON implements stdjson.Marshaler.
func (*UpsertTable) SetName ¶
func (s *UpsertTable) SetName(val string)
SetName sets the value of Name.
func (*UpsertTable) SetSchema ¶
func (s *UpsertTable) SetSchema(val string)
SetSchema sets the value of Schema.
func (*UpsertTable) UnmarshalJSON ¶
func (s *UpsertTable) UnmarshalJSON(data []byte) error
UnmarshalJSON implements stdjson.Unmarshaler.
type User ¶
type User struct { ID uint64 `json:"id"` Username string `json:"username"` FullName string `json:"full_name"` Email string `json:"email"` }
Ref: #/components/schemas/User
func (*User) GetFullName ¶
GetFullName returns the value of FullName.
func (*User) GetUsername ¶
GetUsername returns the value of Username.
func (*User) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*User) SetFullName ¶
SetFullName sets the value of FullName.
func (*User) SetUsername ¶
SetUsername sets the value of Username.
func (*User) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
Source Files ¶
- oas_cfg_gen.go
- oas_client_gen.go
- oas_defaults_gen.go
- oas_handlers_gen.go
- oas_interfaces_gen.go
- oas_json_gen.go
- oas_middleware_gen.go
- oas_parameters_gen.go
- oas_request_decoders_gen.go
- oas_request_encoders_gen.go
- oas_response_decoders_gen.go
- oas_response_encoders_gen.go
- oas_router_gen.go
- oas_schemas_gen.go
- oas_server_gen.go
- oas_unimplemented_gen.go
- oas_validators_gen.go