schema

Documentation

Overview

Package schema Schema link

Index

• type GenerateSchemaData
• type GenerateSchemaRequest
• type GenerateSchemaResponse
• type QuerySchemaData
• type QuerySchemaQuotaData
• type QuerySchemaQuotaRequest
• type QuerySchemaQuotaResponse
• type QuerySchemaRequest
• type QuerySchemaResponse
• type Schema
  • func New(cfg *credential.ContextConfig) *Schema
  • func (s *Schema) Generate(ctx context.Context, request *GenerateSchemaRequest) (response *GenerateSchemaResponse, err error)
  • func (s *Schema) Query(ctx context.Context, request *QuerySchemaRequest) (response *QuerySchemaResponse, err error)
  • func (s *Schema) QueryQuota(ctx context.Context, request *QuerySchemaQuotaRequest) (response *QuerySchemaQuotaResponse, err error)
• type TermSchemaQuota

Types

type GenerateSchemaData

type GenerateSchemaData struct {
	Schema string `json:"schema"`
}

GenerateSchemaData generate schema data

type GenerateSchemaRequest

type GenerateSchemaRequest struct {
	AppID      string `json:"app_id"`
	Query      string `json:"query,omitempty"`
	Path       string `json:"path,omitempty"`
	NoExpire   bool   `json:"no_expire"`
	ExpireTime int    `json:"expire_time,omitempty"`
}

GenerateSchemaRequest generate schema request

type GenerateSchemaResponse

type GenerateSchemaResponse struct {
	base.CommonResponse
	Data GenerateSchemaData `json:"data"`
}

GenerateSchemaResponse generate schema response

type QuerySchemaData

type QuerySchemaData struct {
	AppID      string `json:"app_id"`
	Path       string `json:"path"`
	Query      string `json:"query"`
	CreateTime int    `json:"create_time"`
	ExpireTime int    `json:"expire_time"`
}

QuerySchemaData query schema data

type QuerySchemaQuotaData

type QuerySchemaQuotaData struct {
	LongTermSchemaQuota  TermSchemaQuota `json:"long_term_schema_quota"`
	ShortTermSchemaQuota TermSchemaQuota `json:"short_term_schema_quota"`
}

QuerySchemaQuotaData query schema quota data

type QuerySchemaQuotaRequest

type QuerySchemaQuotaRequest struct {
	AppID string `json:"app_id"`
}

QuerySchemaQuotaRequest query schema quota request

type QuerySchemaQuotaResponse

type QuerySchemaQuotaResponse struct {
	base.CommonResponse
	Data QuerySchemaQuotaData `json:"data"`
}

QuerySchemaQuotaResponse query schema quota response

type QuerySchemaRequest

type QuerySchemaRequest struct {
	Schema string `json:"schema"`
	AppID  string `json:"app_id"`
}

QuerySchemaRequest query schema request

type QuerySchemaResponse

type QuerySchemaResponse struct {
	base.CommonResponse
	Data QuerySchemaData `json:"data"`
}

QuerySchemaResponse query schema response

type Schema

type Schema struct {
	// contains filtered or unexported fields
}

Schema create schema

func New

func New(cfg *credential.ContextConfig) *Schema

New create schema

func (*Schema) Generate

func (s *Schema) Generate(ctx context.Context, request *GenerateSchemaRequest) (response *GenerateSchemaResponse, err error)

Generate generate schema

func (*Schema) Query

func (s *Schema) Query(ctx context.Context, request *QuerySchemaRequest) (response *QuerySchemaResponse, err error)

Query query schema

func (*Schema) QueryQuota

func (s *Schema) QueryQuota(ctx context.Context, request *QuerySchemaQuotaRequest) (response *QuerySchemaQuotaResponse, err error)

QueryQuota query schema quota

type TermSchemaQuota

type TermSchemaQuota struct {
	SchemaLimit int `json:"schema_limit"`
	SchemaUsed  int `json:"schema_used"`
}

TermSchemaQuota term schema quota