domain

Documentation

Index

• Variables
• type APIInfo
• type CommandData
• type ConnectionData
• type DefinitionDetail
• type PropertyDetail
• type RestAPI
• type RestAPIDetail
• type RestAPIParam
• type RestEndPoint
• type ServiceKey
• type ServiceKeyUrls
• type ServiceKeyUsers
• type UserCommand

Variables

var VersionType = plugin.VersionType{Major: 1, Minor: 0, Build: 5}

Types

type APIInfo

type APIInfo struct {
	TokenEnabled string `json:"authTokenEnabled"`
}

type CommandData

type CommandData struct {
	Target             string
	ConnnectionData    ConnectionData
	UserCommand        UserCommand
	AvailableEndpoints map[string]RestEndPoint //key is command name
}

CommandData is all the data involved in executing plugin commands This data gets manipulated throughout the program

type ConnectionData

type ConnectionData struct {
	Username       string
	Password       string
	Token          string
	UseToken       bool
	LocatorAddress string
}

ConnectionData describes items required to connect to a Geode cluster

type DefinitionDetail

type DefinitionDetail struct {
	Properties map[string]PropertyDetail `json:"properties"`
}

DefinitionDetail describes the details of the type definitions

type PropertyDetail

type PropertyDetail struct {
	Type   string            `json:"type"`
	Ref    string            `json:"$ref"`
	Enum   []string          `json:"enum"`
	Format string            `json:"format"`
	Items  map[string]string `json:"items"`
}

PropertyDetail describes the details of the properties of type definitions

type RestAPI

type RestAPI struct {
	Definitions map[string]DefinitionDetail         `json:"definitions"`
	Paths       map[string]map[string]RestAPIDetail `json:"paths"`
	Info        APIInfo                             `json:"info"`
}

RestAPI is used to parse the swagger json response first key: url | second key: method (get/post) | value: RestAPIDetail

type RestAPIDetail

type RestAPIDetail struct {
	CommandName string         `json:"summary"`
	JQFilter    string         `json:"jqFilter"`
	Consumes    []string       `json:"consumes"`
	Parameters  []RestAPIParam `json:"parameters"`
}

RestAPIDetail provides details about an endpoint

type RestAPIParam

type RestAPIParam struct {
	Name        string `json:"name"`
	Required    bool   `json:"required"`
	Description string `json:"description"`
	Type        string `json:"type"`
	// In describes how params are submitted: "query", "body" or "path" , or "formData"
	In             string            `json:"in"`
	Schema         map[string]string `json:"schema"`
	BodyDefinition map[string]interface{}
}

RestAPIParam contains the information about possible parameters for a call

type RestEndPoint

type RestEndPoint struct {
	HTTPMethod  string
	URL         string
	CommandName string
	JQFilter    string
	Consumes    []string
	Parameters  []RestAPIParam
}

RestEndPoint holds endpoint information

type ServiceKey

type ServiceKey struct {
	Urls  ServiceKeyUrls    `json:"urls"`
	Users []ServiceKeyUsers `json:"users"`
}

ServiceKey aggregates the information returned when requesting a service key from CF

type ServiceKeyUrls

type ServiceKeyUrls struct {
	Management string `json:"management"`
	Gfsh       string `json:"gfsh"`
}

ServiceKeyUrls holds URL information for endpoints to the PCC manageability service

type ServiceKeyUsers

type ServiceKeyUsers struct {
	Password string `json:"password"`
	Username string `json:"username"`
}

ServiceKeyUsers holds the username and password for users identified in a CF service key

type UserCommand

type UserCommand struct {
	Command    string
	Parameters map[string]string
}

UserCommand holds command and parameter information entered by a user