types

Documentation

Overview

Package types defines the different interfaces used in the GraphQL implementation

Package types defines the different interfaces used in the GraphQL implementation

Package types defines the different interfaces used in the GraphQL implementation

Package types defines the different interfaces used in the GraphQL implementation

Index

• type ResolverCreatorContract
• type RootResolverContract
• type SortingOptionPair
• type UserEdgeClusterInputArgument
• type UserEdgeClustersInputArgument
• type UserResolverContract
• type UserTenantInputArgument
• type UserTenantsInputArgument

Types

type ResolverCreatorContract

type ResolverCreatorContract interface {
	// NewRootResolver creates new RootResolverContract and returns it
	// ctx: Mandatory. Reference to the context
	// Returns the RootResolverContract or error if something goes wrong
	NewRootResolver(ctx context.Context) (RootResolverContract, error)

	// NewUserResolver creates new UserResolverContract and returns it
	// ctx: Mandatory. Reference to the context
	// userID: Mandatory. The user unique identifier
	// Returns the UserResolverContract or error if something goes wrong
	NewUserResolver(
		ctx context.Context,
		userID string) (UserResolverContract, error)

	relay.PageInfoResolverCreatorContract
	tenant.QueryResolverCreatorContract
	tenant.MutationResolverCreatorContract
	edgecluster.QueryResolverCreatorContract
	edgecluster.MutationResolverCreatorContract
}

ResolverCreatorContract declares the service that can create different resolvers

type RootResolverContract

type RootResolverContract interface {
	// User returns user resolver
	// ctx: Mandatory. Reference to the context
	// Returns the user resolver or error if something goes wrong
	User(ctx context.Context) (UserResolverContract, error)

	tenant.RootResolverContract
	edgecluster.RootResolverContract
}

RootResolverContract declares the root resolver

type SortingOptionPair

type SortingOptionPair struct {
	Name      string
	Direction string
}

type UserEdgeClusterInputArgument

type UserEdgeClusterInputArgument struct {
	EdgeClusterID graphql.ID
}

type UserEdgeClustersInputArgument

type UserEdgeClustersInputArgument struct {
	relay.ConnectionArgument
	SortingOptions *[]SortingOptionPair
	EdgeClusterIDs *[]graphql.ID
	TenantIDs      *[]graphql.ID
}

type UserResolverContract

type UserResolverContract interface {
	// ID returns user unique identifier
	// ctx: Mandatory. Reference to the context
	// Returns the user unique identifier
	ID(ctx context.Context) graphql.ID

	// Tenant returns tenant resolver
	// ctx: Mandatory. Reference to the context
	// args: Mandatory. The argument list
	// Returns the tenant resolver or error if something goes wrong
	Tenant(
		ctx context.Context,
		args UserTenantInputArgument) (tenant.TenantResolverContract, error)

	// Tenants returns tenant connection compatible with graphql-relay
	// ctx: Mandatory. Reference to the context
	// args: Mandatory. The argument list
	// Returns the tenant resolver or error if something goes wrong
	Tenants(
		ctx context.Context,
		args UserTenantsInputArgument) (tenant.TenantTypeConnectionResolverContract, error)

	// EdgeCluster returns tenant resolver
	// ctx: Mandatory. Reference to the context
	// args: Mandatory. The argument list
	// Returns the tenant resolver or error if something goes wrong
	EdgeCluster(
		ctx context.Context,
		args UserEdgeClusterInputArgument) (edgecluster.EdgeClusterResolverContract, error)

	// EdgeClusters returns tenant connection compatible with graphql-relay
	// ctx: Mandatory. Reference to the context
	// args: Mandatory. The argument list
	// Returns the tenant resolver or error if something goes wrong
	EdgeClusters(
		ctx context.Context,
		args UserEdgeClustersInputArgument) (edgecluster.EdgeClusterTypeConnectionResolverContract, error)
}

UserResolverContract declares the resolver that can retrieve user information

type UserTenantInputArgument

type UserTenantInputArgument struct {
	TenantID string
}

type UserTenantsInputArgument

type UserTenantsInputArgument struct {
	relay.ConnectionArgument
	SortingOptions *[]SortingOptionPair
	TenantIDs      *[]graphql.ID
}