bkgql

Documentation

Overview

package bkgql contains a client to the Buildkite GraphQL API

Index

• Constants
• func NewClient(endpoint, token string) graphql.Client
• type GetPipelinePipeline
  • func (v *GetPipelinePipeline) GetId() string
  • func (v *GetPipelinePipeline) GetRepository() GetPipelinePipelineRepository
  • func (v *GetPipelinePipeline) GetSteps() GetPipelinePipelineSteps
• type GetPipelinePipelineRepository
  • func (v *GetPipelinePipelineRepository) GetUrl() string
• type GetPipelinePipelineSteps
  • func (v *GetPipelinePipelineSteps) GetYaml() string
• type GetPipelineResponse
  • func GetPipeline(ctx_ context.Context, client_ graphql.Client, orgPipelineSlug string) (*GetPipelineResponse, error)
  • func (v *GetPipelineResponse) GetPipeline() GetPipelinePipeline
• type UpdatePipelinePipelineUpdatePipelineUpdatePayload
  • func (v *UpdatePipelinePipelineUpdatePipelineUpdatePayload) GetClientMutationId() string
  • func (v *UpdatePipelinePipelineUpdatePipelineUpdatePayload) GetPipeline() UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline
• type UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline
  • func (v *UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline) GetSteps() UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps
• type UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps
  • func (v *UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps) GetYaml() string
• type UpdatePipelineResponse
  • func UpdatePipeline(ctx_ context.Context, client_ graphql.Client, id string, yaml string) (*UpdatePipelineResponse, error)
  • func (v *UpdatePipelineResponse) GetPipelineUpdate() UpdatePipelinePipelineUpdatePipelineUpdatePayload

Constants

const (
	DefaultEndpoint = "https://graphql.buildkite.com/v1"
)

const GetPipeline_Operation = `` /* 139-byte string literal not displayed */

The query or mutation executed by GetPipeline.

const UpdatePipeline_Operation = `` /* 174-byte string literal not displayed */

The query or mutation executed by UpdatePipeline.

Functions

func NewClient

func NewClient(endpoint, token string) graphql.Client

Types

type GetPipelinePipeline

type GetPipelinePipeline struct {
	Id string `json:"id"`
	// The repository for this pipeline
	Repository GetPipelinePipelineRepository `json:"repository"`
	Steps      GetPipelinePipelineSteps      `json:"steps"`
}

GetPipelinePipeline includes the requested fields of the GraphQL type Pipeline. The GraphQL type's documentation follows.

A pipeline

func (*GetPipelinePipeline) GetId

func (v *GetPipelinePipeline) GetId() string

GetId returns GetPipelinePipeline.Id, and is useful for accessing the field via an interface.

func (*GetPipelinePipeline) GetRepository

func (v *GetPipelinePipeline) GetRepository() GetPipelinePipelineRepository

GetRepository returns GetPipelinePipeline.Repository, and is useful for accessing the field via an interface.

func (*GetPipelinePipeline) GetSteps

func (v *GetPipelinePipeline) GetSteps() GetPipelinePipelineSteps

GetSteps returns GetPipelinePipeline.Steps, and is useful for accessing the field via an interface.

type GetPipelinePipelineRepository

type GetPipelinePipelineRepository struct {
	// The git URL for this repository
	Url string `json:"url"`
}

GetPipelinePipelineRepository includes the requested fields of the GraphQL type Repository. The GraphQL type's documentation follows.

A repository associated with a pipeline

func (*GetPipelinePipelineRepository) GetUrl

func (v *GetPipelinePipelineRepository) GetUrl() string

GetUrl returns GetPipelinePipelineRepository.Url, and is useful for accessing the field via an interface.

type GetPipelinePipelineSteps

type GetPipelinePipelineSteps struct {
	// A YAML representation of the pipeline steps
	Yaml string `json:"yaml"`
}

GetPipelinePipelineSteps includes the requested fields of the GraphQL type PipelineSteps. The GraphQL type's documentation follows.

Steps defined on a pipeline

func (*GetPipelinePipelineSteps) GetYaml

func (v *GetPipelinePipelineSteps) GetYaml() string

GetYaml returns GetPipelinePipelineSteps.Yaml, and is useful for accessing the field via an interface.

type GetPipelineResponse

type GetPipelineResponse struct {
	// Find a pipeline
	Pipeline GetPipelinePipeline `json:"pipeline"`
}

GetPipelineResponse is returned by GetPipeline on success.

func GetPipeline

func GetPipeline(
	ctx_ context.Context,
	client_ graphql.Client,
	orgPipelineSlug string,
) (*GetPipelineResponse, error)

func (*GetPipelineResponse) GetPipeline

func (v *GetPipelineResponse) GetPipeline() GetPipelinePipeline

GetPipeline returns GetPipelineResponse.Pipeline, and is useful for accessing the field via an interface.

type UpdatePipelinePipelineUpdatePipelineUpdatePayload

type UpdatePipelinePipelineUpdatePipelineUpdatePayload struct {
	// A unique identifier for the client performing the mutation.
	ClientMutationId string                                                    `json:"clientMutationId"`
	Pipeline         UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline `json:"pipeline"`
}

UpdatePipelinePipelineUpdatePipelineUpdatePayload includes the requested fields of the GraphQL type PipelineUpdatePayload. The GraphQL type's documentation follows.

Autogenerated return type of PipelineUpdate.

func (*UpdatePipelinePipelineUpdatePipelineUpdatePayload) GetClientMutationId

func (v *UpdatePipelinePipelineUpdatePipelineUpdatePayload) GetClientMutationId() string

GetClientMutationId returns UpdatePipelinePipelineUpdatePipelineUpdatePayload.ClientMutationId, and is useful for accessing the field via an interface.

func (*UpdatePipelinePipelineUpdatePipelineUpdatePayload) GetPipeline

func (v *UpdatePipelinePipelineUpdatePipelineUpdatePayload) GetPipeline() UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline

GetPipeline returns UpdatePipelinePipelineUpdatePipelineUpdatePayload.Pipeline, and is useful for accessing the field via an interface.

type UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline

type UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline struct {
	Steps UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps `json:"steps"`
}

UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline includes the requested fields of the GraphQL type Pipeline. The GraphQL type's documentation follows.

A pipeline

func (*UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline) GetSteps

func (v *UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline) GetSteps() UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps

GetSteps returns UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipeline.Steps, and is useful for accessing the field via an interface.

type UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps

type UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps struct {
	// A YAML representation of the pipeline steps
	Yaml string `json:"yaml"`
}

UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps includes the requested fields of the GraphQL type PipelineSteps. The GraphQL type's documentation follows.

Steps defined on a pipeline

func (*UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps) GetYaml

func (v *UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps) GetYaml() string

GetYaml returns UpdatePipelinePipelineUpdatePipelineUpdatePayloadPipelineSteps.Yaml, and is useful for accessing the field via an interface.

type UpdatePipelineResponse

type UpdatePipelineResponse struct {
	// Change the settings for a pipeline.
	PipelineUpdate UpdatePipelinePipelineUpdatePipelineUpdatePayload `json:"pipelineUpdate"`
}

UpdatePipelineResponse is returned by UpdatePipeline on success.

func UpdatePipeline

func UpdatePipeline(
	ctx_ context.Context,
	client_ graphql.Client,
	id string,
	yaml string,
) (*UpdatePipelineResponse, error)

func (*UpdatePipelineResponse) GetPipelineUpdate

func (v *UpdatePipelineResponse) GetPipelineUpdate() UpdatePipelinePipelineUpdatePipelineUpdatePayload

GetPipelineUpdate returns UpdatePipelineResponse.PipelineUpdate, and is useful for accessing the field via an interface.