build.go

// SPDX-License-Identifier: Apache-2.0

package types

import (
	"fmt"
	"strings"
	"time"

	"github.com/go-vela/server/compiler/types/raw"
	"github.com/go-vela/server/constants"
)

// Build is the API types representation of a build for a pipeline.
//
// swagger:model Build
type Build struct {
	ID            *int64              `json:"id,omitempty"`
	Repo          *Repo               `json:"repo,omitempty"`
	PipelineID    *int64              `json:"pipeline_id,omitempty"`
	Number        *int64              `json:"number,omitempty"`
	Parent        *int64              `json:"parent,omitempty"`
	Event         *string             `json:"event,omitempty"`
	EventAction   *string             `json:"event_action,omitempty"`
	Status        *string             `json:"status,omitempty"`
	Error         *string             `json:"error,omitempty"`
	Enqueued      *int64              `json:"enqueued,omitempty"`
	Created       *int64              `json:"created,omitempty"`
	Started       *int64              `json:"started,omitempty"`
	Finished      *int64              `json:"finished,omitempty"`
	Deploy        *string             `json:"deploy,omitempty"`
	DeployNumber  *int64              `json:"deploy_number,omitempty"`
	DeployPayload *raw.StringSliceMap `json:"deploy_payload,omitempty"`
	Clone         *string             `json:"clone,omitempty"`
	Source        *string             `json:"source,omitempty"`
	Title         *string             `json:"title,omitempty"`
	Message       *string             `json:"message,omitempty"`
	Commit        *string             `json:"commit,omitempty"`
	Sender        *string             `json:"sender,omitempty"`
	SenderSCMID   *string             `json:"sender_scm_id,omitempty"`
	Fork          *bool               `json:"fork,omitempty"`
	Author        *string             `json:"author,omitempty"`
	Email         *string             `json:"email,omitempty"`
	Link          *string             `json:"link,omitempty"`
	Branch        *string             `json:"branch,omitempty"`
	Ref           *string             `json:"ref,omitempty"`
	BaseRef       *string             `json:"base_ref,omitempty"`
	HeadRef       *string             `json:"head_ref,omitempty"`
	Host          *string             `json:"host,omitempty"`
	Runtime       *string             `json:"runtime,omitempty"`
	Distribution  *string             `json:"distribution,omitempty"`
	ApprovedAt    *int64              `json:"approved_at,omitempty"`
	ApprovedBy    *string             `json:"approved_by,omitempty"`
}

// Duration calculates and returns the total amount of
// time the build ran for in a human-readable format.
func (b *Build) Duration() string {
	// check if the build doesn't have a started timestamp
	if b.GetStarted() == 0 {
		return constants.ErrorEmptyDuration
	}

	// capture started unix timestamp from the build
	started := time.Unix(b.GetStarted(), 0)

	// check if the build doesn't have a finished timestamp
	if b.GetFinished() == 0 {
		// return the duration in a human-readable form by
		// subtracting the build started time from the
		// current time rounded to the nearest second
		return time.Since(started).Round(time.Second).String()
	}

	// capture finished unix timestamp from the build
	finished := time.Unix(b.GetFinished(), 0)

	// calculate the duration by subtracting the build
	// started time from the build finished time
	duration := finished.Sub(started)

	// return the duration in a human-readable form
	return duration.String()
}

// Environment returns a list of environment variables
// provided from the fields of the Build type.
func (b *Build) Environment(workspace, channel string) map[string]string {
	envs := map[string]string{
		"VELA_BUILD_APPROVED_AT":   ToString(b.GetApprovedAt()),
		"VELA_BUILD_APPROVED_BY":   ToString(b.GetApprovedBy()),
		"VELA_BUILD_AUTHOR":        ToString(b.GetAuthor()),
		"VELA_BUILD_AUTHOR_EMAIL":  ToString(b.GetEmail()),
		"VELA_BUILD_BASE_REF":      ToString(b.GetBaseRef()),
		"VELA_BUILD_BRANCH":        ToString(b.GetBranch()),
		"VELA_BUILD_CHANNEL":       ToString(channel),
		"VELA_BUILD_CLONE":         ToString(b.GetClone()),
		"VELA_BUILD_COMMIT":        ToString(b.GetCommit()),
		"VELA_BUILD_CREATED":       ToString(b.GetCreated()),
		"VELA_BUILD_DISTRIBUTION":  ToString(b.GetDistribution()),
		"VELA_BUILD_ENQUEUED":      ToString(b.GetEnqueued()),
		"VELA_BUILD_EVENT":         ToString(b.GetEvent()),
		"VELA_BUILD_EVENT_ACTION":  ToString(b.GetEventAction()),
		"VELA_BUILD_HOST":          ToString(b.GetHost()),
		"VELA_BUILD_LINK":          ToString(b.GetLink()),
		"VELA_BUILD_MESSAGE":       ToString(b.GetMessage()),
		"VELA_BUILD_NUMBER":        ToString(b.GetNumber()),
		"VELA_BUILD_PARENT":        ToString(b.GetParent()),
		"VELA_BUILD_REF":           ToString(b.GetRef()),
		"VELA_BUILD_RUNTIME":       ToString(b.GetRuntime()),
		"VELA_BUILD_SENDER":        ToString(b.GetSender()),
		"VELA_BUILD_SENDER_SCM_ID": ToString(b.GetSenderSCMID()),
		"VELA_BUILD_STARTED":       ToString(b.GetStarted()),
		"VELA_BUILD_SOURCE":        ToString(b.GetSource()),
		"VELA_BUILD_STATUS":        ToString(b.GetStatus()),
		"VELA_BUILD_TITLE":         ToString(b.GetTitle()),
		"VELA_BUILD_WORKSPACE":     ToString(workspace),

		// deprecated environment variables
		"BUILD_AUTHOR":       ToString(b.GetAuthor()),
		"BUILD_AUTHOR_EMAIL": ToString(b.GetEmail()),
		"BUILD_BASE_REF":     ToString(b.GetBaseRef()),
		"BUILD_BRANCH":       ToString(b.GetBranch()),
		"BUILD_CHANNEL":      ToString(channel),
		"BUILD_CLONE":        ToString(b.GetClone()),
		"BUILD_COMMIT":       ToString(b.GetCommit()),
		"BUILD_CREATED":      ToString(b.GetCreated()),
		"BUILD_ENQUEUED":     ToString(b.GetEnqueued()),
		"BUILD_EVENT":        ToString(b.GetEvent()),
		"BUILD_HOST":         ToString(b.GetHost()),
		"BUILD_LINK":         ToString(b.GetLink()),
		"BUILD_MESSAGE":      ToString(b.GetMessage()),
		"BUILD_NUMBER":       ToString(b.GetNumber()),
		"BUILD_PARENT":       ToString(b.GetParent()),
		"BUILD_REF":          ToString(b.GetRef()),
		"BUILD_SENDER":       ToString(b.GetSender()),
		"BUILD_STARTED":      ToString(b.GetStarted()),
		"BUILD_SOURCE":       ToString(b.GetSource()),
		"BUILD_STATUS":       ToString(b.GetStatus()),
		"BUILD_TITLE":        ToString(b.GetTitle()),
		"BUILD_WORKSPACE":    ToString(workspace),
	}

	// check if the Build event is comment
	if strings.EqualFold(b.GetEvent(), constants.EventComment) {
		// capture the pull request number
		number := ToString(strings.SplitN(b.GetRef(), "/", 4)[2])

		// add the pull request number to the list
		envs["BUILD_PULL_REQUEST_NUMBER"] = number
		envs["VELA_BUILD_PULL_REQUEST"] = number
		envs["VELA_PULL_REQUEST"] = number
		envs["VELA_PULL_REQUEST_SOURCE"] = b.GetHeadRef()
		envs["VELA_PULL_REQUEST_TARGET"] = b.GetBaseRef()
	}

	// check if the Build event is deployment
	if strings.EqualFold(b.GetEvent(), constants.EventDeploy) {
		// capture the deployment target
		target := ToString(b.GetDeploy())

		// add the deployment target to the list
		envs["VELA_BUILD_TARGET"] = target
		envs["VELA_DEPLOYMENT"] = target
		envs["BUILD_TARGET"] = target
		envs["VELA_DEPLOYMENT_NUMBER"] = ToString(b.GetDeployNumber())

		// handle when deployment event is for a tag
		if strings.HasPrefix(b.GetRef(), "refs/tags/") {
			// capture the tag reference
			tag := ToString(strings.SplitN(b.GetRef(), "refs/tags/", 2)[1])

			// add the tag reference to the list
			envs["BUILD_TAG"] = tag
			envs["VELA_BUILD_TAG"] = tag
		}

		// add payload data to the list
		for key, value := range b.GetDeployPayload() {
			envs[fmt.Sprintf("DEPLOYMENT_PARAMETER_%s", strings.ToUpper(key))] = value
		}
	}

	// check if the Build event is pull_request
	if strings.EqualFold(b.GetEvent(), constants.EventPull) {
		// capture the pull request number
		number := ToString(strings.SplitN(b.GetRef(), "/", 4)[2])

		// add the pull request number to the list
		envs["BUILD_PULL_REQUEST_NUMBER"] = number
		envs["VELA_BUILD_PULL_REQUEST"] = number
		envs["VELA_PULL_REQUEST"] = number
		envs["VELA_PULL_REQUEST_SOURCE"] = b.GetHeadRef()
		envs["VELA_PULL_REQUEST_TARGET"] = b.GetBaseRef()
		envs["VELA_PULL_REQUEST_FORK"] = ToString(b.GetFork())
	}

	// check if the Build event is tag
	if strings.EqualFold(b.GetEvent(), constants.EventTag) {
		// capture the tag reference
		tag := ToString(strings.SplitN(b.GetRef(), "refs/tags/", 2)[1])

		// add the tag reference to the list
		envs["BUILD_TAG"] = tag
		envs["VELA_BUILD_TAG"] = tag
	}

	// check if the Build event is delete:tag
	if strings.EqualFold(b.GetEvent(), constants.EventDelete) && strings.EqualFold(b.GetEventAction(), constants.ActionTag) {
		// capture the tag reference, which has been stored in the Branch variable due to issues that arose
		// when the Ref is set to the deleted tag
		tag := b.GetBranch()

		// add the tag reference to the list
		envs["BUILD_TAG"] = tag
		envs["VELA_BUILD_TAG"] = tag
	}

	return envs
}

// GetID returns the ID field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetID() int64 {
	// return zero value if Build type or ID field is nil
	if b == nil || b.ID == nil {
		return 0
	}

	return *b.ID
}

// GetRepo returns the Repo field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetRepo() *Repo {
	// return zero value if Build type or Repo field is nil
	if b == nil || b.Repo == nil {
		return new(Repo)
	}

	return b.Repo
}

// GetPipelineID returns the PipelineID field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetPipelineID() int64 {
	// return zero value if Build type or PipelineID field is nil
	if b == nil || b.PipelineID == nil {
		return 0
	}

	return *b.PipelineID
}

// GetNumber returns the Number field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetNumber() int64 {
	// return zero value if Build type or Number field is nil
	if b == nil || b.Number == nil {
		return 0
	}

	return *b.Number
}

// GetParent returns the Parent field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetParent() int64 {
	// return zero value if Build type or Parent field is nil
	if b == nil || b.Parent == nil {
		return 0
	}

	return *b.Parent
}

// GetEvent returns the Event field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetEvent() string {
	// return zero value if Build type or Event field is nil
	if b == nil || b.Event == nil {
		return ""
	}

	return *b.Event
}

// GetEventAction returns the EventAction field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetEventAction() string {
	// return zero value if Build type or EventAction field is nil
	if b == nil || b.EventAction == nil {
		return ""
	}

	return *b.EventAction
}

// GetStatus returns the Status field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetStatus() string {
	// return zero value if Build type or Status field is nil
	if b == nil || b.Status == nil {
		return ""
	}

	return *b.Status
}

// GetError returns the Error field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetError() string {
	// return zero value if Build type or Error field is nil
	if b == nil || b.Error == nil {
		return ""
	}

	return *b.Error
}

// GetEnqueued returns the Enqueued field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetEnqueued() int64 {
	// return zero value if Build type or Enqueued field is nil
	if b == nil || b.Enqueued == nil {
		return 0
	}

	return *b.Enqueued
}

// GetCreated returns the Created field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetCreated() int64 {
	// return zero value if Build type or Created field is nil
	if b == nil || b.Created == nil {
		return 0
	}

	return *b.Created
}

// GetStarted returns the Started field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetStarted() int64 {
	// return zero value if Build type or Started field is nil
	if b == nil || b.Started == nil {
		return 0
	}

	return *b.Started
}

// GetFinished returns the Finished field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetFinished() int64 {
	// return zero value if Build type or Finished field is nil
	if b == nil || b.Finished == nil {
		return 0
	}

	return *b.Finished
}

// GetDeploy returns the Deploy field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetDeploy() string {
	// return zero value if Build type or Deploy field is nil
	if b == nil || b.Deploy == nil {
		return ""
	}

	return *b.Deploy
}

// GetDeployNumber returns the DeployNumber field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetDeployNumber() int64 {
	// return zero value if Build type or Deploy field is nil
	if b == nil || b.DeployNumber == nil {
		return 0
	}

	return *b.DeployNumber
}

// GetDeployPayload returns the DeployPayload field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetDeployPayload() raw.StringSliceMap {
	// return zero value if Build type or Deploy field is nil
	if b == nil || b.DeployPayload == nil {
		return raw.StringSliceMap{}
	}

	return *b.DeployPayload
}

// GetClone returns the Clone field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetClone() string {
	// return zero value if Build type or Clone field is nil
	if b == nil || b.Clone == nil {
		return ""
	}

	return *b.Clone
}

// GetSource returns the Source field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetSource() string {
	// return zero value if Build type or Source field is nil
	if b == nil || b.Source == nil {
		return ""
	}

	return *b.Source
}

// GetTitle returns the Title field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetTitle() string {
	// return zero value if Build type or Title field is nil
	if b == nil || b.Title == nil {
		return ""
	}

	return *b.Title
}

// GetMessage returns the Message field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetMessage() string {
	// return zero value if Build type or Message field is nil
	if b == nil || b.Message == nil {
		return ""
	}

	return *b.Message
}

// GetCommit returns the Commit field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetCommit() string {
	// return zero value if Build type or Commit field is nil
	if b == nil || b.Commit == nil {
		return ""
	}

	return *b.Commit
}

// GetSender returns the Sender field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetSender() string {
	// return zero value if Build type or Sender field is nil
	if b == nil || b.Sender == nil {
		return ""
	}

	return *b.Sender
}

// GetSenderSCMID returns the SenderSCMID field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetSenderSCMID() string {
	// return zero value if Build type or SenderSCMID field is nil
	if b == nil || b.SenderSCMID == nil {
		return ""
	}

	return *b.SenderSCMID
}

// GetFork returns the Fork field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetFork() bool {
	// return zero value if Build type or Fork field is nil
	if b == nil || b.Fork == nil {
		return false
	}

	return *b.Fork
}

// GetAuthor returns the Author field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetAuthor() string {
	// return zero value if Build type or Author field is nil
	if b == nil || b.Author == nil {
		return ""
	}

	return *b.Author
}

// GetEmail returns the Email field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetEmail() string {
	// return zero value if Build type or Email field is nil
	if b == nil || b.Email == nil {
		return ""
	}

	return *b.Email
}

// GetLink returns the Link field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetLink() string {
	// return zero value if Build type or Link field is nil
	if b == nil || b.Link == nil {
		return ""
	}

	return *b.Link
}

// GetBranch returns the Branch field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetBranch() string {
	// return zero value if Build type or Branch field is nil
	if b == nil || b.Branch == nil {
		return ""
	}

	return *b.Branch
}

// GetRef returns the Ref field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetRef() string {
	// return zero value if Build type or Ref field is nil
	if b == nil || b.Ref == nil {
		return ""
	}

	return *b.Ref
}

// GetBaseRef returns the BaseRef field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetBaseRef() string {
	// return zero value if Build type or BaseRef field is nil
	if b == nil || b.BaseRef == nil {
		return ""
	}

	return *b.BaseRef
}

// GetHeadRef returns the HeadRef field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetHeadRef() string {
	// return zero value if Build type or HeadRef field is nil
	if b == nil || b.HeadRef == nil {
		return ""
	}

	return *b.HeadRef
}

// GetHost returns the Host field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetHost() string {
	// return zero value if Build type or Host field is nil
	if b == nil || b.Host == nil {
		return ""
	}

	return *b.Host
}

// GetRuntime returns the Runtime field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetRuntime() string {
	// return zero value if Build type or Runtime field is nil
	if b == nil || b.Runtime == nil {
		return ""
	}

	return *b.Runtime
}

// GetDistribution returns the Distribution field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetDistribution() string {
	// return zero value if Build type or Distribution field is nil
	if b == nil || b.Distribution == nil {
		return ""
	}

	return *b.Distribution
}

// GetApprovedAt returns the ApprovedAt field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetApprovedAt() int64 {
	// return zero value if Build type or ApprovedAt field is nil
	if b == nil || b.ApprovedAt == nil {
		return 0
	}

	return *b.ApprovedAt
}

// GetApprovedBy returns the ApprovedBy field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetApprovedBy() string {
	// return zero value if Build type or ApprovedBy field is nil
	if b == nil || b.ApprovedBy == nil {
		return ""
	}

	return *b.ApprovedBy
}

// SetID sets the ID field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetID(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.ID = &v
}

// SetRepo sets the Repo field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetRepo(v *Repo) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Repo = v
}

// SetPipelineID sets the PipelineID field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetPipelineID(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.PipelineID = &v
}

// SetNumber sets the Number field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetNumber(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Number = &v
}

// SetParent sets the Parent field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetParent(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Parent = &v
}

// SetEvent sets the Event field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetEvent(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Event = &v
}

// SetEventAction sets the EventAction field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetEventAction(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.EventAction = &v
}

// SetStatus sets the Status field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetStatus(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Status = &v
}

// SetError sets the Error field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetError(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Error = &v
}

// SetEnqueued sets the Enqueued field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetEnqueued(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Enqueued = &v
}

// SetCreated sets the Created field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetCreated(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Created = &v
}

// SetStarted sets the Started field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetStarted(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Started = &v
}

// SetFinished sets the Finished field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetFinished(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Finished = &v
}

// SetDeploy sets the Deploy field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetDeploy(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Deploy = &v
}

// SetDeployNumber sets the DeployNumber field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetDeployNumber(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.DeployNumber = &v
}

// SetDeployPayload sets the DeployPayload field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetDeployPayload(v raw.StringSliceMap) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.DeployPayload = &v
}

// SetClone sets the Clone field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetClone(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Clone = &v
}

// SetSource sets the Source field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetSource(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Source = &v
}

// SetTitle sets the Title field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetTitle(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Title = &v
}

// SetMessage sets the Message field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetMessage(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Message = &v
}

// SetCommit sets the Commit field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetCommit(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Commit = &v
}

// SetSender sets the Sender field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetSender(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Sender = &v
}

// SetSenderSCMID sets the SenderSCMID field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetSenderSCMID(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.SenderSCMID = &v
}

// SetFork sets the Fork field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetFork(v bool) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Fork = &v
}

// SetAuthor sets the Author field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetAuthor(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Author = &v
}

// SetEmail sets the Email field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetEmail(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Email = &v
}

// SetLink sets the Link field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetLink(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Link = &v
}

// SetBranch sets the Branch field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetBranch(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Branch = &v
}

// SetRef sets the Ref field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetRef(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Ref = &v
}

// SetBaseRef sets the BaseRef field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetBaseRef(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.BaseRef = &v
}

// SetHeadRef sets the HeadRef field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetHeadRef(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.HeadRef = &v
}

// SetHost sets the Host field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetHost(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Host = &v
}

// SetRuntime sets the Runtime field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetRuntime(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Runtime = &v
}

// SetDistribution sets the Distribution field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetDistribution(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.Distribution = &v
}

// SetApprovedAt sets the ApprovedAt field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetApprovedAt(v int64) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.ApprovedAt = &v
}

// SetApprovedBy sets the ApprovedBy field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetApprovedBy(v string) {
	// return if Build type is nil
	if b == nil {
		return
	}

	b.ApprovedBy = &v
}

// String implements the Stringer interface for the Build type.
func (b *Build) String() string {
	return fmt.Sprintf(`{
  ApprovedAt: %d,
  ApprovedBy: %s,
  Author: %s,
  BaseRef: %s,
  Branch: %s,
  Clone: %s,
  Commit: %s,
  Created: %d,
  Deploy: %s,
  DeployNumber: %d,
  DeployPayload: %s,
  Distribution: %s,
  Email: %s,
  Enqueued: %d,
  Error: %s,
  Event: %s,
  EventAction: %s,
  Finished: %d,
  Fork: %t,
  HeadRef: %s,
  Host: %s,
  ID: %d,
  Link: %s,
  Message: %s,
  Number: %d,
  Parent: %d,
  PipelineID: %d,
  Ref: %s,
  Repo: %s,
  Runtime: %s,
  Sender: %s,
  SenderSCMID: %s,
  Source: %s,
  Started: %d,
  Status: %s,
  Title: %s,
}`,
		b.GetApprovedAt(),
		b.GetApprovedBy(),
		b.GetAuthor(),
		b.GetBaseRef(),
		b.GetBranch(),
		b.GetClone(),
		b.GetCommit(),
		b.GetCreated(),
		b.GetDeploy(),
		b.GetDeployNumber(),
		b.GetDeployPayload(),
		b.GetDistribution(),
		b.GetEmail(),
		b.GetEnqueued(),
		b.GetError(),
		b.GetEvent(),
		b.GetEventAction(),
		b.GetFinished(),
		b.GetFork(),
		b.GetHeadRef(),
		b.GetHost(),
		b.GetID(),
		b.GetLink(),
		b.GetMessage(),
		b.GetNumber(),
		b.GetParent(),
		b.GetPipelineID(),
		b.GetRef(),
		b.GetRepo().GetFullName(),
		b.GetRuntime(),
		b.GetSender(),
		b.GetSenderSCMID(),
		b.GetSource(),
		b.GetStarted(),
		b.GetStatus(),
		b.GetTitle(),
	)
}

// StatusSanitize removes sensitive information before producing a "status".
func (b *Build) StatusSanitize() {
	// sanitize repo
	if b.Repo != nil {
		b.Repo.StatusSanitize()
	}

	b.Email = nil
	b.DeployPayload = nil
}