api

type AgentPauseRequest struct {
	Note             string `json:"note,omitempty"`
	TimeoutInMinutes int    `json:"timeout_in_minutes,omitempty"`
}

type AgentRegisterRequest struct {
	Name               string   `json:"name"`
	Hostname           string   `json:"hostname"`
	OS                 string   `json:"os"`
	Arch               string   `json:"arch"`
	ScriptEvalEnabled  bool     `json:"script_eval_enabled"`
	IgnoreInDispatches bool     `json:"ignore_in_dispatches"`
	Priority           string   `json:"priority,omitempty"`
	Version            string   `json:"version"`
	Build              string   `json:"build"`
	Tags               []string `json:"meta_data"`
	PID                int      `json:"pid,omitempty"`
	MachineID          string   `json:"machine_id,omitempty"`
	Features           []string `json:"features"`
}

type AgentRegisterResponse struct {
	UUID              string            `json:"id"`
	Name              string            `json:"name"`
	AccessToken       string            `json:"access_token"`
	Endpoint          string            `json:"endpoint"`
	RequestHeaders    map[string]string `json:"request_headers"`
	PingInterval      int               `json:"ping_interval"`
	JobStatusInterval int               `json:"job_status_interval"`
	HeartbeatInterval int               `json:"heartbeat_interval"`
	Tags              []string          `json:"meta_data"`
	Tracing           *AgentTracing     `json:"tracing,omitempty"`
}

type AgentStopRequest struct {
	Force bool `json:"force,omitempty"`
}

type AgentTokenIdentity struct {
	UUID                  string `json:"uuid"`
	Description           string `json:"description"`
	TokenType             string `json:"token_type"`
	OrganizationSlug      string `json:"organization_slug"`
	OrganizationUUID      string `json:"organization_uuid"`
	ClusterUUID           string `json:"cluster_uuid"`
	ClusterName           string `json:"cluster_name"`
	OrganizationQueueUUID string `json:"organization_queue_uuid"`
	OrganizationQueueKey  string `json:"organization_queue_key"`
}

type AgentTracing struct {
	Backend              string           `json:"backend"`
	PropagateTraceparent bool             `json:"propagate_traceparent"`
	Exporter             *TracingExporter `json:"exporter,omitempty"`
}

type Annotation struct {
	Body     string `json:"body,omitempty"`
	Context  string `json:"context,omitempty"`
	Style    string `json:"style,omitempty"`
	Append   bool   `json:"append,omitempty"`
	Priority int    `json:"priority,omitempty"`
	Scope    string `json:"scope,omitempty"`
}

type Artifact struct {
	// The ID of the artifact. The ID is assigned to it after a successful
	// batch creation
	ID string `json:"id"`

	// The path to the artifact relative to the working directory
	Path string `json:"path"`

	// The absolute path to the artifact
	AbsolutePath string `json:"absolute_path"`

	// The glob path used to find this artifact
	GlobPath string `json:"glob_path"`

	// The size of the file in bytes
	FileSize int64 `json:"file_size"`

	// A SHA-1 hash of the uploaded file
	Sha1Sum string `json:"sha1sum"`

	// A SHA-2 256-bit hash of the uploaded file, possibly empty
	Sha256Sum string `json:"sha256sum"`

	// ID of the job that created this artifact (from API)
	JobID string `json:"job_id"`

	// UTC timestamp this artifact was considered created
	CreatedAt time.Time `json:"created_at"`

	// The HTTP url to this artifact once it's been uploaded
	URL string `json:"url,omitempty"`

	// The destination specified on the command line when this file was
	// uploaded
	UploadDestination string `json:"upload_destination,omitempty"`

	// Information on how to upload this artifact.
	UploadInstructions *ArtifactUploadInstructions `json:"-"`

	// A specific Content-Type to use on upload
	ContentType string `json:"content_type,omitempty"`
}

type ArtifactBatch struct {
	ID                 string      `json:"id"`
	Artifacts          []*Artifact `json:"artifacts"`
	UploadDestination  string      `json:"upload_destination"`
	MultipartSupported bool        `json:"multipart_supported,omitempty"`
}

type ArtifactBatchCreateResponse struct {
	ID          string   `json:"id"`
	ArtifactIDs []string `json:"artifact_ids"`

	// These instructions apply to all artifacts. The template contains
	// variable interpolations such as ${artifact:path}.
	InstructionsTemplate *ArtifactUploadInstructions `json:"upload_instructions"`

	// These instructions apply to specific artifacts, necessary for multipart
	// uploads. It overrides InstructionTemplate and should not contain
	// interpolations. Map: artifact ID -> instructions for that artifact.
	PerArtifactInstructions map[string]*ArtifactUploadInstructions `json:"per_artifact_instructions"`
}

type ArtifactBatchUpdateRequest struct {
	Artifacts []ArtifactState `json:"artifacts"`
}

type ArtifactPartETag struct {
	PartNumber int    `json:"part_number"`
	ETag       string `json:"etag"`
}

type ArtifactSearchOptions struct {
	Query              string `url:"query,omitempty"`
	Scope              string `url:"scope,omitempty"`
	State              string `url:"state,omitempty"`
	IncludeRetriedJobs bool   `url:"include_retried_jobs,omitempty"`
	IncludeDuplicates  bool   `url:"include_duplicates,omitempty"`
}

type ArtifactState struct {
	ID        string `json:"id"`
	State     string `json:"state"`
	Multipart bool   `json:"multipart,omitempty"`
	// If this artifact was a multipart upload and is complete, we need the
	// the ETag from each uploaded part so that they can be joined together.
	MultipartETags []ArtifactPartETag `json:"multipart_etags,omitempty"`
}

type ArtifactUploadAction struct {
	URL        string `json:"url,omitempty"`
	Method     string `json:"method"`
	Path       string `json:"path"`
	FileInput  string `json:"file_input"`
	PartNumber int    `json:"part_number,omitempty"`
}

type ArtifactUploadInstructions struct {
	// Used for a single-part upload.
	Action ArtifactUploadAction `json:"action"`

	// Used for a multi-part upload.
	Actions []ArtifactUploadAction `json:"actions"`

	// Contains other data necessary for interpreting instructions.
	Data map[string]string `json:"data"`
}

type Build struct {
	UUID string `json:"uuid"`
}

type CacheBlob struct {
	Digest      CacheDigest `json:"digest"`
	FileSize    int64       `json:"file_size"`
	Compression string      `json:"compression"` // "zstd" | "zip"
}

type CacheDigest struct {
	Algorithm string `json:"algorithm"` // "sha256"
	Value     string `json:"value"`
}

type CacheEntryCommitReq struct {
	UploadID string   `json:"upload_id"`
	ETags    []string `json:"e_tags,omitempty"`
}

type CacheEntryCommitResp struct {
	Message string `json:"message"`
}

type CacheEntryCreateReq struct {
	TargetPaths []string       `json:"target_paths"`
	CacheKey    []CacheKeyPart `json:"cache_key"`
	Blobs       []CacheBlob    `json:"blobs"`
	Platform    string         `json:"platform"`
}

type CacheEntryCreateResp struct {
	UploadID           string   `json:"upload_id"`
	Multipart          bool     `json:"multipart"`
	UploadInstructions []string `json:"upload_instructions"`
	Message            string   `json:"message"`
}

type CacheEntryExpireReq struct {
	TargetPaths []string       `json:"target_paths"`
	CacheKey    []CacheKeyPart `json:"cache_key"`
}

type CacheEntryPeekReq struct {
	TargetPaths []string       `json:"target_paths"`
	CacheKey    []CacheKeyPart `json:"cache_key"`
}

type CacheEntryPeekResp struct {
	TargetPaths []string       `json:"target_paths"`
	CacheKey    []CacheKeyPart `json:"cache_key"`
	Blobs       []CacheBlob    `json:"blobs"`
	Store       string         `json:"store"`
	Message     string         `json:"message"`
}

type CacheEntryRetrieveReq struct {
	TargetPaths []string       `json:"target_paths"`
	CacheKey    []CacheKeyPart `json:"cache_key"`
}

type CacheEntryRetrieveResp struct {
	TargetPaths          []string       `json:"target_paths"`
	CacheKey             []CacheKeyPart `json:"cache_key"`
	Blobs                []CacheBlob    `json:"blobs"`
	ExpiresAt            time.Time      `json:"expires_at"`
	Store                string         `json:"store"`
	Fallback             bool           `json:"fallback"`
	Multipart            bool           `json:"multipart"`
	DownloadInstructions []string       `json:"download_instructions"`
	Message              string         `json:"message"`
}

type CacheKeyPart struct {
	Value     string `json:"value"`
	Mandatory bool   `json:"mandatory"`
}

type CacheRegistryResp struct {
	UUID  string `json:"uuid"`
	Name  string `json:"name"`
	Store string `json:"store"`
}

type Chunk struct {
	Data            []byte
	Sequence        uint64
	Offset          uint64
	Size            uint64
	CompressedBytes uint64
}

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

type Config struct {
	// Endpoint for API requests. Defaults to the public Buildkite Agent API.
	// The URL should always be specified with a trailing slash.
	Endpoint string

	// The authentication token to use, either a registration or access token
	Token string

	// User agent used when communicating with the Buildkite Agent API.
	UserAgent string

	// If true, only HTTP2 is disabled
	DisableHTTP2 bool

	// If true, requests and responses will be dumped and set to the logger
	DebugHTTP bool

	// If true timings for each request will be logged
	TraceHTTP bool

	// The http client used, leave nil for the default
	HTTPClient *http.Client

	// optional TLS configuration primarily used for testing
	TLSConfig *tls.Config

	// HTTP client timeout; zero to use default
	Timeout time.Duration
}

type ErrorResponse struct {
	Response *http.Response // HTTP response that caused this error
	Message  string         `json:"message"` // error message

	// Details of a response body that wasn't an API error message. Taken from the
	// response, never decoded from it, hence `json:"-"`.
	ContentType string `json:"-"`
	Snippet     string `json:"-"`
}

type GetSecretRequest struct {
	Key   string
	JobID string
}

type Header struct {
	Name  string
	Value string
}

type HeaderTimes struct {
	Times map[string]string `json:"header_times"`
}

type Heartbeat struct {
	SentAt     string `json:"sent_at"`
	ReceivedAt string `json:"received_at,omitempty"`
}

type Job struct {
	ID                    string                     `json:"id"`
	Endpoint              string                     `json:"endpoint"`
	State                 string                     `json:"state"`
	Env                   map[string]string          `json:"env"`
	Step                  pipeline.CommandStep       `json:"step"`
	MatrixPermutation     pipeline.MatrixPermutation `json:"matrix_permutation"`
	ChunksMaxSizeBytes    uint64                     `json:"chunks_max_size_bytes"`
	ChunksIntervalSeconds int                        `json:"chunks_interval_seconds"`
	LogMaxSizeBytes       uint64                     `json:"log_max_size_bytes"`
	Token                 string                     `json:"token"`
	ExitStatus            string                     `json:"exit_status"`
	Signal                string                     `json:"signal"`
	SignalReason          string                     `json:"signal_reason"`
	StartedAt             string                     `json:"started_at"`
	FinishedAt            string                     `json:"finished_at"`
	RunnableAt            string                     `json:"runnable_at"`
	ChunksFailedCount     int                        `json:"chunks_failed_count"`
	TraceParent           string                     `json:"traceparent"`
	TraceState            string                     `json:"tracestate"`
	Priority              int                        `json:"priority"`
}

type JobFinishRequest struct {
	ExitStatus              string `json:"exit_status,omitempty"`
	Signal                  string `json:"signal,omitempty"`
	SignalReason            string `json:"signal_reason,omitempty"`
	FinishedAt              string `json:"finished_at,omitempty"`
	ChunksFailedCount       int    `json:"chunks_failed_count"`
	IgnoreAgentInDispatches *bool  `json:"ignore_agent_in_dispatches,omitempty"`
}

type JobPromiseFailureRequest struct {
	ExitStatus int    `json:"exit_status"`
	Reason     string `json:"reason,omitempty"`
}

type JobState struct {
	State string `json:"state,omitempty"`
}

type JobUpdateResponse struct {
	ID string `json:"id"`
}

type MetaData struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

type MetaDataBatch struct {
	Items []MetaData `json:"items"`
}

type MetaDataExists struct {
	Exists bool `json:"exists"`
}

type OIDCToken struct {
	Token string `json:"token"`
}

type OIDCTokenRequest struct {
	Job            string
	Audience       string
	Lifetime       int
	Claims         []string
	AWSSessionTags []string
	SubjectClaim   string
}

type Ping struct {
	Action         string            `json:"action,omitempty"`
	Message        string            `json:"message,omitempty"`
	Job            *Job              `json:"job,omitempty"`
	Endpoint       string            `json:"endpoint,omitempty"`
	RequestHeaders map[string]string `json:"request_headers,omitzero"` // omit nil, keep empty map
}

type PipelineChange struct {
	// UUID identifies this pipeline change. We keep this constant during
	// retry loops so that work is not repeated on the API server
	UUID     string `json:"uuid"`
	Pipeline any    `json:"pipeline"`
	Replace  bool   `json:"replace,omitempty"`
}

type PipelineUploadStatus struct {
	State   string `json:"state"`
	Message string `json:"message"`
}

type RepositoryAccessTokenRequest struct {
	RepoURL string `json:"repo_url,omitempty"`
}

type RepositoryAccessTokenResponse struct {
	Token string `json:"token,omitempty"`
}

type Response struct {
	*http.Response
}

type Secret struct {
	Key   string `json:"key"`
	Value string `json:"value"`
	UUID  string `json:"uuid"`
}

type StepCancel struct {
	Build                   string `json:"build_id"`
	Force                   bool   `json:"force"`
	ForceGracePeriodSeconds int64  `json:"force_grace_period"`
}

type StepCancelResponse struct {
	UUID string `json:"uuid"`
}

type StepExportRequest struct {
	Attribute string `json:"attribute,omitempty"`
	Build     string `json:"build_id,omitempty"`
	Format    string `json:"format,omitempty"`
}

type StepExportResponse struct {
	Output string `json:"output"`
}

type StepUpdate struct {
	IdempotencyUUID string `json:"idempotency_uuid,omitempty"`
	Build           string `json:"build_id,omitempty"`
	Attribute       string `json:"attribute,omitempty"`
	Value           string `json:"value,omitempty"`
	Append          bool   `json:"append,omitempty"`
}

type TracingExporter struct {
	Endpoint string            `json:"endpoint"`
	Protocol string            `json:"protocol"`
	Headers  map[string]string `json:"headers,omitempty"`
}

type UndecodableResponseError struct {
	Method      string // request method
	URL         string // request URL, after any redirects
	Status      string // response status
	ContentType string // response content type
	Snippet     string // start of the response body; empty when it could hold credentials
	Err         error  // the decoding error
}