stacksapi

type BatchReserveJobsRequest struct {
	StackKey                 string   `json:"-"`                                   // The key of the stack calling this endpoint. Required.
	JobUUIDs                 []string `json:"job_uuids"`                           // The UUIDs of the jobs to reserve. Required.
	ReservationExpirySeconds int      `json:"reservation_expiry_seconds,omitzero"` // The number of seconds until the reservation expires. Optional, defaults to 300 (5 minutes) if not set.
}

type BatchReserveJobsResponse struct {
	Reserved    []string `json:"reserved"`     // The UUIDs of the jobs that were successfully reserved
	NotReserved []string `json:"not_reserved"` // The UUIDs of the jobs that could not be reserved (e.g. because they were already reserved by another stack, or because they're no longer in a reservable state)
}

type Build struct {
	UUID   string `json:"uuid"`
	Number int    `json:"number"`
	Branch string `json:"branch"`
}

type Client struct {
	// contains filtered or unexported fields
}

type ClientOpt func(*Client) error

type ClusterQueue struct {
	ID     string `json:"id"`
	Paused bool   `json:"paused"`
}

type CreateStackNotificationRequest struct {
	StackKey string `json:"-"`      // The key to call the stack. Required.
	JobUUID  string `json:"-"`      // The uuid of a job
	Detail   string `json:"detail"` // Short notification message (max length 255)
}

type ErrorResponse struct {
	Response *http.Response `json:"-"`       // HTTP response that caused this error. The Body will be closed.
	RawBody  []byte         `json:"-"`       // Raw Response Body
	Message  string         `json:"message"` // Error message from Buildkite API
}

type FailJobRequest struct {
	StackKey    string `json:"-"` // The key to call the stack. Required.
	JobUUID     string `json:"-"` // The uuid of a job
	ExitStatus  int    `json:"exit_status,omitzero"`
	ErrorDetail string `json:"error_detail"` // An error detail string less than 4KB.
}

type GetJobRequest struct {
	StackKey string `json:"-"` // The key to call the stack. Required.
	JobUUID  string `json:"-"` // The uuid of a job. Required.
}

type GetJobResponse struct {
	ID      string            `json:"id"`
	Env     map[string]string `json:"env"`
	Command string            `json:"command"`
}

type GetJobStatesRequest struct {
	StackKey string   `json:"-"`         // The key to call the stack. Required.
	JobUUIDs []string `json:"job_uuids"` // A list of job uuids
}

type GetJobStatesResponse struct {
	States map[string]string `json:"states"`
}

type ListScheduledJobsRequest struct {
	StackKey        string // The key of the stack calling this endpoint. Required
	ClusterQueueKey string // The key of the cluster queue to list jobs from. Required
	PageSize        int    // The number of jobs to return. Optional, defaults to a sensible value on the backend
	StartCursor     string // The cursor to start the page from. Optional, defaults to the start of the list
}

type ListScheduledJobsResponse struct {
	Jobs         []ScheduledJob `json:"jobs"`          // A list of jobs that are in the scheduled state
	ClusterQueue ClusterQueue   `json:"cluster_queue"` // The cluster queue the jobs were fetched from
	PageInfo     PageInfo       `json:"page_info"`     // Information about pagination
}

type PageInfo struct {
	HasNextPage bool   `json:"has_next_page"` // Whether there are more pages of results
	EndCursor   string `json:"end_cursor"`    // The cursor to use to fetch the next page of results
}

type Pipeline struct {
	Slug string `json:"slug"`
	UUID string `json:"uuid"`
}

type RegisterStackRequest struct {
	Key      string            `json:"key,omitempty"`       // The key to call the stack. Required.
	Type     StackType         `json:"type,omitempty"`      // A type for the stack. Required.
	QueueKey string            `json:"queue_key,omitempty"` // The key of a queue for the stack to listen to. Required
	Metadata map[string]string `json:"metadata"`            // Key-value metadata to associate with the queue. Required, but can be empty
}

type RegisterStackResponse struct {
	ID               string            `json:"id"`
	OrganizationUUID string            `json:"organization_uuid"`
	ClusterQueueKey  string            `json:"cluster_queue_key"`
	Key              string            `json:"key"`
	Type             StackType         `json:"type"`
	Metadata         map[string]string `json:"metadata"`
	LastConnectedOn  *time.Time        `json:"last_connected_on"`
	State            StackState        `json:"state"`
}

type RequestOption func(*StackAPIRequest) error

type ScheduledJob struct {
	ID              string    `json:"id"`                // The UUID of the job
	Priority        int       `json:"priority"`          // The priority of the job; higher priority jobs should be scheduled first
	AgentQueryRules []string  `json:"agent_query_rules"` // The agent tags that must be matched to run the job
	ScheduledAt     time.Time `json:"scheduled_at"`      // When the job was scheduled
	Pipeline        Pipeline  `json:"pipeline"`          // The pipeline the job belongs to
	Build           Build     `json:"build"`             // The build the job belongs to
	Step            Step      `json:"step"`              // The step the job was created by
}

type StackAPIRequest struct {
	*http.Request
	// contains filtered or unexported fields
}

type StackState string

type StackType string

type Step struct {
	Key string `json:"key"`
}