api

package
v2.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 10, 2024 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIClient

type APIClient struct {
	*pairecservice.Client

	// API Services
	ExperimentApi *ExperimentApiService

	ExperimentGroupApi *ExperimentGroupApiService

	ExperimentRoomApi *ExperimentRoomApiService

	LayerApi *LayerApiService

	SceneApi *SceneApiService

	ParamApi *ParamApiService

	CrowdApi *CrowdApiService

	FlowCtrlApi *FlowCtrlApiService

	FeatureConsistencyCheckApi *FeatureConsistencyCheckService
	// contains filtered or unexported fields
}

APIClient manages communication with the Pairec Experiment Restful Api API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(instanceId, region, accessId, accessKey string) (*APIClient, error)

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetDomain

func (c *APIClient) GetDomain() string

func (*APIClient) SetDomain added in v2.0.1

func (c *APIClient) SetDomain(domain string)

type BaseResponse

type BaseResponse struct {
	RequestId string `json:"request_id,omitempty"`
	Code      string `json:"code,omitempty"`
	Message   string `json:"message,omitempty"`
}

type CrowdApiService

type CrowdApiService service

func (*CrowdApiService) GetCrowdUsersById

func (a *CrowdApiService) GetCrowdUsersById(crowdId int64) (ListCrowdUsersResponse, error)

CrowdApiService Get Crowd users By crowd ID Get Crowd users By crowd ID

@return ListCrowdUsersResponse

type ExperimentApiListExperimentsOpts

type ExperimentApiListExperimentsOpts struct {
	Status optional.Uint32
}

type ExperimentApiService

type ExperimentApiService service

func (*ExperimentApiService) ListExperiments

func (a *ExperimentApiService) ListExperiments(expGroupId int64, localVarOptionals *ExperimentApiListExperimentsOpts) (ListExperimentsResponse, error)

type ExperimentGroupApiListExperimentGroupsOpts

type ExperimentGroupApiListExperimentGroupsOpts struct {
	Status optional.Uint32
}

type ExperimentGroupApiService

type ExperimentGroupApiService service

func (*ExperimentGroupApiService) ListExperimentGroups

type ExperimentRoomApiListExperimentRoomsOpts

type ExperimentRoomApiListExperimentRoomsOpts struct {
	SceneId optional.Int64
	Status  optional.Uint32
}

type ExperimentRoomApiService

type ExperimentRoomApiService service

func (*ExperimentRoomApiService) ListExperimentRooms

func (a *ExperimentRoomApiService) ListExperimentRooms(environment string, localVarOptionals *ExperimentRoomApiListExperimentRoomsOpts) (ListExperimentRoomsResponse, error)

type FeatureConsistencyBackflowResponse added in v2.0.2

type FeatureConsistencyBackflowResponse struct {
	RequestId string `json:"RequestId"`
}

type FeatureConsistencyCheckService added in v2.0.2

type FeatureConsistencyCheckService service

func (*FeatureConsistencyCheckService) BackflowFeatureConsistencyCheckJobData added in v2.0.2

func (a *FeatureConsistencyCheckService) BackflowFeatureConsistencyCheckJobData(backflowData *model.FeatureConsistencyBackflowData) (FeatureConsistencyBackflowResponse, error)

BackflowFeatureConsistencyCheckJobData send backflow log data to pairec config server

@return FeatureConsistencyBackflowResponse

func (*FeatureConsistencyCheckService) SyncFeatureConsistencyCheckJobReplayLog added in v2.0.2

func (a *FeatureConsistencyCheckService) SyncFeatureConsistencyCheckJobReplayLog(replyData *model.FeatureConsistencyReplyData) (FeatureConsistencyReplyResponse, error)

SyncFeatureConsistencyCheckJobReplayLog send reply log data to pairec config server

@return FeatureConsistencyReplyResponse

type FeatureConsistencyReplyResponse added in v2.0.2

type FeatureConsistencyReplyResponse struct {
	RequestId string `json:"RequestId"`
}

type FlowCtrlApiListFlowCtrlPlansOpts

type FlowCtrlApiListFlowCtrlPlansOpts struct {
	SceneId optional.Int32
	Status  optional.String
	Env     optional.String
}

type FlowCtrlApiService

type FlowCtrlApiService service

type LayerApiService

type LayerApiService service

func (*LayerApiService) ListLayers

func (a *LayerApiService) ListLayers(expRoomId int64) (ListLayersResponse, error)

LayerApiService list all Layers By filter condition

  • @param expRoomId list all layers of the experiment room

@return Response

type ListCrowdUsersResponse

type ListCrowdUsersResponse struct {
	Users      []string `json:"Users,omitempty"`
	CrowdUsers []string `json:"CrowdUsers,omitempty"`
}

type ListExperimentGroupsResponse

type ListExperimentGroupsResponse struct {
	ExperimentGroups []*model.ExperimentGroup
}

type ListExperimentRoomsResponse

type ListExperimentRoomsResponse struct {
	ExperimentRooms []*model.ExperimentRoom
}

type ListExperimentsResponse

type ListExperimentsResponse struct {
	Experiments []*model.Experiment
}

type ListFlowCtrlPlansResponse

type ListFlowCtrlPlansResponse struct {
	BaseResponse
	Data struct {
		Plans []model.FlowCtrlPlan `json:"plans"`
	} `json:"data,omitempty"`
}

type ListLayersResponse

type ListLayersResponse struct {
	Layers []*model.Layer
}

type ListParamsResponse

type ListParamsResponse struct {
	Params []*model.Param
}

type ListScenesResponse

type ListScenesResponse struct {
	//BaseResponse
	Scenes []*model.Scene
}

type ParamApiGetParamOpts

type ParamApiGetParamOpts struct {
	Environment optional.String
	ParamId     optional.Int64
	ParamName   optional.String
}

type ParamApiService

type ParamApiService service

func (*ParamApiService) GetParam

func (a *ParamApiService) GetParam(sceneId int64, localVarOptionals *ParamApiGetParamOpts) (ListParamsResponse, error)

type Response

type Response struct {
	BaseResponse
	Data map[string]interface{} `json:"data,omitempty"`
}

type SceneApiService

type SceneApiService service

func (*SceneApiService) ListAllScenes

func (a *SceneApiService) ListAllScenes() (ListScenesResponse, error)

SceneApiService Get all scenes @return ListScenesResponse

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL