structs

Documentation

Index

• type PageInfo
• type QueryFieldConstraint
• type QueryOrder
• type QueryPredicate
• type RunState
• type RunStateTransition
  • func (r *RunStateTransition) About() string
  • func (r *RunStateTransition) Error() error
• type RunType
  • func NewRunType(in string) *RunType
• type SearchInput

Types

type PageInfo

type PageInfo struct {
	EndCursor       string `json:"endCursor"`
	HasNextPage     bool   `json:"hasNextPage"`
	HasPreviousPage bool   `json:"hasPreviousPage"`
}

PageInfo is the extra information about a searched page.

type QueryFieldConstraint

type QueryFieldConstraint struct {
	BooleanEquals *[]graphql.Boolean `json:"booleanEquals"`
	EnumEquals    *[]graphql.String  `json:"enumEquals"`
	StringMatches *[]graphql.String  `json:"stringMatches"`
}

QueryFieldConstraint is a constraint used in a search query.

type QueryOrder

type QueryOrder struct {
	Field     graphql.String `json:"field"`
	Direction graphql.String `json:"direction"`
}

QueryOrder is the order in which the results should be returned.

type QueryPredicate

type QueryPredicate struct {
	Field      graphql.String       `json:"field"`
	Constraint QueryFieldConstraint `json:"constraint"`
	Exclude    graphql.Boolean      `json:"exclude"`
}

QueryPredicate Field and Constraint pair for search input.

type RunState

type RunState string

RunState is the state of the run.

type RunStateTransition

type RunStateTransition struct {
	HasLogs      bool     `graphql:"hasLogs"`
	Note         *string  `graphql:"note"`
	State        RunState `graphql:"state"`
	StateVersion int      `graphql:"stateVersion"`
	Terminal     bool     `graphql:"terminal"`
	Timestamp    int      `graphql:"timestamp"`
	Username     *string  `graphql:"username"`
}

RunStateTransition represents a single run state transition.

func (*RunStateTransition) About

func (r *RunStateTransition) About() string

About returns "header" information about the state transition.

func (*RunStateTransition) Error

func (r *RunStateTransition) Error() error

type RunType

type RunType string

RunType is the type of the run.

func NewRunType

func NewRunType(in string) *RunType

NewRunType takes a string and returns a pointer to a RunType.

type SearchInput

type SearchInput struct {
	First          *graphql.Int      `json:"first"`
	After          *graphql.String   `json:"after"`
	FullTextSearch *graphql.String   `json:"fullTextSearch"`
	Predicates     *[]QueryPredicate `json:"predicates"`
	OrderBy        *QueryOrder       `json:"orderBy"`
}

SearchInput is the main object provided to any search query.