library

package
v0.2.0-rc4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2020 License: Apache-2.0 Imports: 5 Imported by: 56

Documentation

Overview

Package library provides the defined library types for Vela.

Usage: 

import "github.com/go-vela/types/library"

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildWithContext 

func BuildWithContext(c context.Context, b *Build) context.Context

BuildWithContext inserts the Build type to the context.

func LogWithContext 

func LogWithContext(c context.Context, l *Log) context.Context

LogWithContext inserts the Log type to the context.

func RepoWithContext 

func RepoWithContext(c context.Context, r *Repo) context.Context

RepoWithContext inserts the library Repo type to the context.

func SecretWithContext 

func SecretWithContext(c context.Context, s *Secret) context.Context

SecretWithContext inserts the Secret type to the context.

func StepWithContext 

func StepWithContext(c context.Context, s *Step) context.Context

StepWithContext inserts the Step type to the context.

func UserWithContext 

func UserWithContext(c context.Context, u *User) context.Context

UserWithContext inserts the User type to the context.

Types

type Build 

type Build struct {
	ID           *int64  `json:"id,omitempty"`
	RepoID       *int64  `json:"repo_id,omitempty"`
	Number       *int    `json:"number,omitempty"`
	Parent       *int    `json:"parent,omitempty"`
	Event        *string `json:"event,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"`
	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"`
	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"`
	Host         *string `json:"host,omitempty"`
	Runtime      *string `json:"runtime,omitempty"`
	Distribution *string `json:"distribution,omitempty"`
}

Build is the library representation of a build for a pipeline.

func BuildFromContext 

func BuildFromContext(c context.Context) *Build

BuildFromContext retrieves the Build type from the context.

func (*Build) GetAuthor 

func (b *Build) GetAuthor() string

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 (*Build) GetBaseRef 

func (b *Build) GetBaseRef() string

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 (*Build) GetBranch 

func (b *Build) GetBranch() string

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 (*Build) GetClone 

func (b *Build) GetClone() string

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 (*Build) GetCommit 

func (b *Build) GetCommit() string

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 (*Build) GetCreated 

func (b *Build) GetCreated() int64

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 (*Build) GetDeploy 

func (b *Build) GetDeploy() string

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 (*Build) GetDistribution 

func (b *Build) GetDistribution() string

GetDistribution 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 (*Build) GetEmail added in v0.2.0 

func (b *Build) GetEmail() string

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 (*Build) GetEnqueued 

func (b *Build) GetEnqueued() int64

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 (*Build) GetError 

func (b *Build) GetError() string

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 (*Build) GetEvent 

func (b *Build) GetEvent() string

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 (*Build) GetFinished 

func (b *Build) GetFinished() int64

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 (*Build) GetHost 

func (b *Build) GetHost() string

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 (*Build) GetID 

func (b *Build) GetID() int64

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) GetLink() string

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 (*Build) GetMessage 

func (b *Build) GetMessage() string

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 (*Build) GetNumber 

func (b *Build) GetNumber() int

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 (*Build) GetParent 

func (b *Build) GetParent() int

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 (*Build) GetRef 

func (b *Build) GetRef() string

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 (*Build) GetRepoID 

func (b *Build) GetRepoID() int64

GetRepoID returns the RepoID 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 (*Build) GetRuntime 

func (b *Build) GetRuntime() string

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 (*Build) GetSender 

func (b *Build) GetSender() string

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 (*Build) GetSource 

func (b *Build) GetSource() string

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 (*Build) GetStarted 

func (b *Build) GetStarted() int64

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 (*Build) GetStatus 

func (b *Build) GetStatus() string

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 (*Build) GetTitle 

func (b *Build) GetTitle() string

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 (*Build) SetAuthor 

func (b *Build) SetAuthor(v string)

SetAuthor sets the Author field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetBaseRef 

func (b *Build) SetBaseRef(v string)

SetBaseRef sets the BaseRef field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetBranch 

func (b *Build) SetBranch(v string)

SetBranch sets the Branch field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetClone 

func (b *Build) SetClone(v string)

SetClone sets the Clone field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetCommit 

func (b *Build) SetCommit(v string)

SetCommit sets the Commit field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetCreated 

func (b *Build) SetCreated(v int64)

SetCreated sets the Created field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetDeploy 

func (b *Build) SetDeploy(v string)

SetDeploy sets the Deploy field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetDistribution 

func (b *Build) SetDistribution(v string)

SetDistribution sets the Runtime field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetEmail added in v0.2.0 

func (b *Build) SetEmail(v string)

SetEmail sets the Email field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetEnqueued 

func (b *Build) SetEnqueued(v int64)

SetEnqueued sets the Enqueued field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetError 

func (b *Build) SetError(v string)

SetError sets the Error field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetEvent 

func (b *Build) SetEvent(v string)

SetEvent sets the Event field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetFinished 

func (b *Build) SetFinished(v int64)

SetFinished sets the Finished field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetHost 

func (b *Build) SetHost(v string)

SetHost sets the Host field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetID 

func (b *Build) SetID(v int64)

SetID sets the ID field.

When the provided Build type is nil, it will set nothing and immediately return. 

func (b *Build) SetLink(v string)

SetLink sets the Link field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetMessage 

func (b *Build) SetMessage(v string)

SetMessage sets the Message field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetNumber 

func (b *Build) SetNumber(v int)

SetNumber sets the Number field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetParent 

func (b *Build) SetParent(v int)

SetParent sets the Parent field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetRef 

func (b *Build) SetRef(v string)

SetRef sets the Ref field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetRepoID 

func (b *Build) SetRepoID(v int64)

SetRepoID sets the RepoID field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetRuntime 

func (b *Build) SetRuntime(v string)

SetRuntime sets the Runtime field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetSender 

func (b *Build) SetSender(v string)

SetSender sets the Sender field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetSource 

func (b *Build) SetSource(v string)

SetSource sets the Source field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetStarted 

func (b *Build) SetStarted(v int64)

SetStarted sets the Started field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetStatus 

func (b *Build) SetStatus(v string)

SetStatus sets the Status field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) SetTitle 

func (b *Build) SetTitle(v string)

SetTitle sets the Title field.

When the provided Build type is nil, it will set nothing and immediately return.

func (*Build) String 

func (b *Build) String() string

String implements the Stringer interface for the Build type.

type Executor added in v0.2.0 

type Executor struct {
	ID           *int64          `json:"id,omitempty"`
	Host         *string         `json:"host,omitempty"`
	Runtime      *string         `json:"runtime,omitempty"`
	Distribution *string         `json:"distribution,omitempty"`
	Build        *Build          `json:"build,omitempty"`
	Repo         *Repo           `json:"repo,omitempty"`
	Pipeline     *pipeline.Build `json:"pipeline,omitempty"`
}

Executor is the library representation of an executor for a worker.

func (*Executor) GetBuild added in v0.2.0 

func (e *Executor) GetBuild() Build

GetBuild returns the Build field.

When the provided Executor type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Executor) GetDistribution added in v0.2.0 

func (e *Executor) GetDistribution() string

GetDistribution returns the Distribution field.

When the provided Executor type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Executor) GetHost added in v0.2.0 

func (e *Executor) GetHost() string

GetHost returns the Host field.

When the provided Executor type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Executor) GetID added in v0.2.0 

func (e *Executor) GetID() int64

GetID returns the ID field.

When the provided Executor type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Executor) GetPipeline added in v0.2.0 

func (e *Executor) GetPipeline() pipeline.Build

GetPipeline returns the Pipeline field.

When the provided Executor type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Executor) GetRepo added in v0.2.0 

func (e *Executor) GetRepo() Repo

GetRepo returns the Repo field.

When the provided Executor type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Executor) GetRuntime added in v0.2.0 

func (e *Executor) GetRuntime() string

GetRuntime returns the Runtime field.

When the provided Executor type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Executor) SetBuild added in v0.2.0 

func (e *Executor) SetBuild(v Build)

SetBuild sets the Build field.

When the provided Executor type is nil, it will set nothing and immediately return.

func (*Executor) SetDistribution added in v0.2.0 

func (e *Executor) SetDistribution(v string)

SetDistribution sets the Distribution field.

When the provided Executor type is nil, it will set nothing and immediately return.

func (*Executor) SetHost added in v0.2.0 

func (e *Executor) SetHost(v string)

SetHost sets the Host field.

When the provided Executor type is nil, it will set nothing and immediately return.

func (*Executor) SetID added in v0.2.0 

func (e *Executor) SetID(v int64)

SetID sets the ID field.

When the provided Executor type is nil, it will set nothing and immediately return.

func (*Executor) SetPipeline added in v0.2.0 

func (e *Executor) SetPipeline(v pipeline.Build)

SetPipeline sets the pipeline Build field.

When the provided Executor type is nil, it will set nothing and immediately return.

func (*Executor) SetRepo added in v0.2.0 

func (e *Executor) SetRepo(v Repo)

SetRepo sets the Repo field.

When the provided Executor type is nil, it will set nothing and immediately return.

func (*Executor) SetRuntime added in v0.2.0 

func (e *Executor) SetRuntime(v string)

SetRuntime sets the Runtime field.

When the provided Executor type is nil, it will set nothing and immediately return.

func (*Executor) String added in v0.2.0 

func (e *Executor) String() string

String implements the Stringer interface for the Executor type.

type Hook added in v0.2.0 

type Hook struct {
	ID       *int64  `json:"id,omitempty"`
	RepoID   *int64  `json:"repo_id,omitempty"`
	BuildID  *int64  `json:"build_id,omitempty"`
	Number   *int    `json:"number,omitempty"`
	SourceID *string `json:"source_id,omitempty"`
	Created  *int64  `json:"created,omitempty"`
	Host     *string `json:"host,omitempty"`
	Event    *string `json:"event,omitempty"`
	Branch   *string `json:"branch,omitempty"`
	Error    *string `json:"error,omitempty"`
	Status   *string `json:"status,omitempty"`
	Link     *string `json:"link,omitempty"`
}

Hook is the library representation of a webhook for a repo.

func (*Hook) GetBranch added in v0.2.0 

func (h *Hook) GetBranch() string

GetBranch returns the Branch field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetBuildID added in v0.2.0 

func (h *Hook) GetBuildID() int64

GetBuildID returns the BuildID field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetCreated added in v0.2.0 

func (h *Hook) GetCreated() int64

GetCreated returns the Created field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetError added in v0.2.0 

func (h *Hook) GetError() string

GetError returns the Error field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetEvent added in v0.2.0 

func (h *Hook) GetEvent() string

GetEvent returns the Event field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetHost added in v0.2.0 

func (h *Hook) GetHost() string

GetHost returns the Host field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetID added in v0.2.0 

func (h *Hook) GetID() int64

GetID returns the ID field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field. 

func (h *Hook) GetLink() string

GetLink returns the Link field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetNumber added in v0.2.0 

func (h *Hook) GetNumber() int

GetNumber returns the Number field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetRepoID added in v0.2.0 

func (h *Hook) GetRepoID() int64

GetRepoID returns the RepoID field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetSourceID added in v0.2.0 

func (h *Hook) GetSourceID() string

GetSourceID returns the SourceID field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) GetStatus added in v0.2.0 

func (h *Hook) GetStatus() string

GetStatus returns the Status field.

When the provided Hook type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Hook) SetBranch added in v0.2.0 

func (h *Hook) SetBranch(v string)

SetBranch sets the Branch field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetBuildID added in v0.2.0 

func (h *Hook) SetBuildID(v int64)

SetBuildID sets the BuildID field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetCreated added in v0.2.0 

func (h *Hook) SetCreated(v int64)

SetCreated sets the Created field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetError added in v0.2.0 

func (h *Hook) SetError(v string)

SetError sets the Error field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetEvent added in v0.2.0 

func (h *Hook) SetEvent(v string)

SetEvent sets the Event field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetHost added in v0.2.0 

func (h *Hook) SetHost(v string)

SetHost sets the Host field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetID added in v0.2.0 

func (h *Hook) SetID(v int64)

SetID sets the ID field.

When the provided Hook type is nil, it will set nothing and immediately return. 

func (h *Hook) SetLink(v string)

SetLink sets the Link field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetNumber added in v0.2.0 

func (h *Hook) SetNumber(v int)

SetNumber sets the Number field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetRepoID added in v0.2.0 

func (h *Hook) SetRepoID(v int64)

SetRepoID sets the RepoID field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetSourceID added in v0.2.0 

func (h *Hook) SetSourceID(v string)

SetSourceID sets the SourceID field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) SetStatus added in v0.2.0 

func (h *Hook) SetStatus(v string)

SetStatus sets the Status field.

When the provided Hook type is nil, it will set nothing and immediately return.

func (*Hook) String added in v0.2.0 

func (h *Hook) String() string

String implements the Stringer interface for the Hook type.

type Log 

type Log struct {
	ID        *int64  `json:"id,omitempty"`
	BuildID   *int64  `json:"build_id,omitempty"`
	RepoID    *int64  `json:"repo_id,omitempty"`
	ServiceID *int64  `json:"service_id,omitempty"`
	StepID    *int64  `json:"step_id,omitempty"`
	Data      *[]byte `json:"data,omitempty"`
}

Log is the library representation of a log for a step in a build.

func LogFromContext 

func LogFromContext(c context.Context) *Log

LogFromContext retrieves the Log type from the context.

func (*Log) GetBuildID 

func (l *Log) GetBuildID() int64

GetBuildID returns the BuildID field.

When the provided Log type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Log) GetData 

func (l *Log) GetData() []byte

GetData returns the Data field.

When the provided Log type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Log) GetID 

func (l *Log) GetID() int64

GetID returns the ID field.

When the provided Log type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Log) GetRepoID 

func (l *Log) GetRepoID() int64

GetRepoID returns the RepoID field.

When the provided Log type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Log) GetServiceID 

func (l *Log) GetServiceID() int64

GetServiceID returns the ServiceID field.

When the provided Log type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Log) GetStepID 

func (l *Log) GetStepID() int64

GetStepID returns the StepID field.

When the provided Log type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Log) SetBuildID 

func (l *Log) SetBuildID(v int64)

SetBuildID sets the BuildID field.

When the provided Log type is nil, it will set nothing and immediately return.

func (*Log) SetData 

func (l *Log) SetData(v []byte)

SetData sets the Data field.

When the provided Log type is nil, it will set nothing and immediately return.

func (*Log) SetID 

func (l *Log) SetID(v int64)

SetID sets the ID field.

When the provided Log type is nil, it will set nothing and immediately return.

func (*Log) SetRepoID 

func (l *Log) SetRepoID(v int64)

SetRepoID sets the RepoID field.

When the provided Log type is nil, it will set nothing and immediately return.

func (*Log) SetServiceID added in v0.1.2 

func (l *Log) SetServiceID(v int64)

SetServiceID sets the ServiceID field.

When the provided Log type is nil, it will set nothing and immediately return.

func (*Log) SetStepID 

func (l *Log) SetStepID(v int64)

SetStepID sets the StepID field.

When the provided Log type is nil, it will set nothing and immediately return.

func (*Log) String 

func (l *Log) String() string

String implements the Stringer interface for the Log type.

type Login 

type Login struct {
	Username *string `json:"username,omitempty"`
	Password *string `json:"password,omitempty"`
	OTP      *string `json:"otp,omitempty"`
	Token    *string `json:"token,omitempty"`
}

Login is the library representation of a user login.

func (*Login) GetOTP 

func (l *Login) GetOTP() string

GetOTP returns the Username field.

When the provided Login type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Login) GetPassword 

func (l *Login) GetPassword() string

GetPassword returns the Password field.

When the provided Login type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Login) GetToken 

func (l *Login) GetToken() string

GetToken returns the Token field.

When the provided Login type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Login) GetUsername 

func (l *Login) GetUsername() string

GetUsername returns the Username field.

When the provided Login type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Login) SetOTP 

func (l *Login) SetOTP(v string)

SetOTP sets the OTP field.

When the provided Login type is nil, it will set nothing and immediately return.

func (*Login) SetPassword 

func (l *Login) SetPassword(v string)

SetPassword sets the Password field.

When the provided Login type is nil, it will set nothing and immediately return.

func (*Login) SetToken 

func (l *Login) SetToken(v string)

SetToken sets the Token field.

When the provided Login type is nil, it will set nothing and immediately return.

func (*Login) SetUsername 

func (l *Login) SetUsername(v string)

SetUsername sets the Username field.

When the provided Login type is nil, it will set nothing and immediately return.

func (*Login) String 

func (l *Login) String() string

String implements the Stringer interface for the Login type.

type Repo 

type Repo struct {
	ID          *int64  `json:"id,omitempty"`
	UserID      *int64  `json:"user_id,omitempty"`
	Hash        *string `json:"-"`
	Org         *string `json:"org,omitempty"`
	Name        *string `json:"name,omitempty"`
	FullName    *string `json:"full_name,omitempty"`
	Link        *string `json:"link,omitempty"`
	Clone       *string `json:"clone,omitempty"`
	Branch      *string `json:"branch,omitempty"`
	Timeout     *int64  `json:"timeout,omitempty"`
	Visibility  *string `json:"visibility,omitempty"`
	Private     *bool   `json:"private,omitempty"`
	Trusted     *bool   `json:"trusted,omitempty"`
	Active      *bool   `json:"active,omitempty"`
	AllowPull   *bool   `json:"allow_pull,omitempty"`
	AllowPush   *bool   `json:"allow_push,omitempty"`
	AllowDeploy *bool   `json:"allow_deploy,omitempty"`
	AllowTag    *bool   `json:"allow_tag,omitempty"`
}

Repo is the library representation of a repo.

func RepoFromContext 

func RepoFromContext(c context.Context) *Repo

RepoFromContext retrieves the Repo type from the context.

func (*Repo) GetActive 

func (r *Repo) GetActive() bool

GetActive returns the Active field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetAllowDeploy 

func (r *Repo) GetAllowDeploy() bool

GetAllowDeploy returns the AllowDeploy field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetAllowPull 

func (r *Repo) GetAllowPull() bool

GetAllowPull returns the AllowPull field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetAllowPush 

func (r *Repo) GetAllowPush() bool

GetAllowPush returns the AllowPush field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetAllowTag 

func (r *Repo) GetAllowTag() bool

GetAllowTag returns the AllowTag field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetBranch 

func (r *Repo) GetBranch() string

GetBranch returns the Branch field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetClone 

func (r *Repo) GetClone() string

GetClone returns the Clone field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetFullName 

func (r *Repo) GetFullName() string

GetFullName returns the FullName field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetHash added in v0.3.0 

func (r *Repo) GetHash() string

GetHash returns the Hash field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetID 

func (r *Repo) GetID() int64

GetID returns the ID field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field. 

func (r *Repo) GetLink() string

GetLink returns the Link field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetName 

func (r *Repo) GetName() string

GetName returns the Name field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetOrg 

func (r *Repo) GetOrg() string

GetOrg returns the Org field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetPrivate 

func (r *Repo) GetPrivate() bool

GetPrivate returns the Private field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetTimeout 

func (r *Repo) GetTimeout() int64

GetTimeout returns the Timeout field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetTrusted 

func (r *Repo) GetTrusted() bool

GetTrusted returns the Trusted field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetUserID 

func (r *Repo) GetUserID() int64

GetUserID returns the UserID field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) GetVisibility 

func (r *Repo) GetVisibility() string

GetVisibility returns the Visibility field.

When the provided Repo type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Repo) SetActive 

func (r *Repo) SetActive(v bool)

SetActive sets the Active field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetAllowDeploy 

func (r *Repo) SetAllowDeploy(v bool)

SetAllowDeploy sets the AllowDeploy field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetAllowPull 

func (r *Repo) SetAllowPull(v bool)

SetAllowPull sets the AllowPull field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetAllowPush 

func (r *Repo) SetAllowPush(v bool)

SetAllowPush sets the AllowPush field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetAllowTag 

func (r *Repo) SetAllowTag(v bool)

SetAllowTag sets the AllowTag field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetBranch 

func (r *Repo) SetBranch(v string)

SetBranch sets the Branch field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetClone 

func (r *Repo) SetClone(v string)

SetClone sets the Clone field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetFullName 

func (r *Repo) SetFullName(v string)

SetFullName sets the FullName field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetHash added in v0.3.0 

func (r *Repo) SetHash(v string)

SetHash sets the Hash field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetID 

func (r *Repo) SetID(v int64)

SetID sets the ID field.

When the provided Repo type is nil, it will set nothing and immediately return. 

func (r *Repo) SetLink(v string)

SetLink sets the Link field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetName 

func (r *Repo) SetName(v string)

SetName sets the Name field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetOrg 

func (r *Repo) SetOrg(v string)

SetOrg sets the Org field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetPrivate 

func (r *Repo) SetPrivate(v bool)

SetPrivate sets the Private field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetTimeout 

func (r *Repo) SetTimeout(v int64)

SetTimeout sets the Timeout field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetTrusted 

func (r *Repo) SetTrusted(v bool)

SetTrusted sets the Trusted field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetUserID 

func (r *Repo) SetUserID(v int64)

SetUserID sets the UserID field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) SetVisibility 

func (r *Repo) SetVisibility(v string)

SetVisibility sets the Visibility field.

When the provided Repo type is nil, it will set nothing and immediately return.

func (*Repo) String 

func (r *Repo) String() string

String implements the Stringer interface for the Repo type.

type Secret 

type Secret struct {
	ID           *int64    `json:"id,omitempty"`
	Org          *string   `json:"org,omitempty"`
	Repo         *string   `json:"repo,omitempty"`
	Team         *string   `json:"team,omitempty"`
	Name         *string   `json:"name,omitempty"`
	Value        *string   `json:"value,omitempty"`
	Type         *string   `json:"type,omitempty"`
	Images       *[]string `json:"images,omitempty"`
	Events       *[]string `json:"events,omitempty"`
	AllowCommand *bool     `json:"allow_command,omitempty"`
}

Secret is the library representation of a secret.

func SecretFromContext 

func SecretFromContext(c context.Context) *Secret

SecretFromContext retrieves the Secret type from the context.

func (*Secret) GetAllowCommand added in v0.1.3 

func (s *Secret) GetAllowCommand() bool

GetAllowCommand returns the AllowCommand field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetEvents 

func (s *Secret) GetEvents() []string

GetEvents returns the Events field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetID 

func (s *Secret) GetID() int64

GetID returns the ID field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetImages 

func (s *Secret) GetImages() []string

GetImages returns the Images field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetName 

func (s *Secret) GetName() string

GetName returns the Name field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetOrg 

func (s *Secret) GetOrg() string

GetOrg returns the Org field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetRepo 

func (s *Secret) GetRepo() string

GetRepo returns the Repo field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetTeam 

func (s *Secret) GetTeam() string

GetTeam returns the Team field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetType 

func (s *Secret) GetType() string

GetType returns the Type field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) GetValue 

func (s *Secret) GetValue() string

GetValue returns the Value field.

When the provided Secret type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Secret) Match 

func (s *Secret) Match(from *pipeline.Container) bool

Match returns true when the provided container matches the conditions to inject a secret into a pipeline container resource

func (*Secret) Sanitize 

func (s *Secret) Sanitize() *Secret

Sanitize creates a duplicate of the Secret without the value.

func (*Secret) SetAllowCommand added in v0.1.3 

func (s *Secret) SetAllowCommand(v bool)

SetAllowCommand sets the AllowCommand field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetEvents 

func (s *Secret) SetEvents(v []string)

SetEvents sets the Events field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetID 

func (s *Secret) SetID(v int64)

SetID sets the ID field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetImages 

func (s *Secret) SetImages(v []string)

SetImages sets the Images field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetName 

func (s *Secret) SetName(v string)

SetName sets the Name field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetOrg 

func (s *Secret) SetOrg(v string)

SetOrg sets the Org field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetRepo 

func (s *Secret) SetRepo(v string)

SetRepo sets the Repo field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetTeam 

func (s *Secret) SetTeam(v string)

SetTeam sets the Team field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetType 

func (s *Secret) SetType(v string)

SetType sets the Type field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) SetValue 

func (s *Secret) SetValue(v string)

SetValue sets the Value field.

When the provided Secret type is nil, it will set nothing and immediately return.

func (*Secret) String 

func (s *Secret) String() string

String implements the Stringer interface for the Secret type.

type Service 

type Service struct {
	ID       *int64  `json:"id,omitempty"`
	BuildID  *int64  `json:"build_id,omitempty"`
	RepoID   *int64  `json:"repo_id,omitempty"`
	Number   *int    `json:"number,omitempty"`
	Name     *string `json:"name,omitempty"`
	Image    *string `json:"image,omitempty"`
	Status   *string `json:"status,omitempty"`
	Error    *string `json:"error,omitempty"`
	ExitCode *int    `json:"exit_code,omitempty"`
	Created  *int64  `json:"created,omitempty"`
	Started  *int64  `json:"started,omitempty"`
	Finished *int64  `json:"finished,omitempty"`
}

Service is the library representation of a service in a build.

func (*Service) GetBuildID 

func (s *Service) GetBuildID() int64

GetBuildID returns the BuildID field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetCreated 

func (s *Service) GetCreated() int64

GetCreated returns the Created field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetError 

func (s *Service) GetError() string

GetError returns the Error field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetExitCode 

func (s *Service) GetExitCode() int

GetExitCode returns the ExitCode field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetFinished 

func (s *Service) GetFinished() int64

GetFinished returns the Finished field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetID 

func (s *Service) GetID() int64

GetID returns the ID field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetImage added in v0.2.0 

func (s *Service) GetImage() string

GetImage returns the Image field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetName 

func (s *Service) GetName() string

GetName returns the Name field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetNumber 

func (s *Service) GetNumber() int

GetNumber returns the Number field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetRepoID 

func (s *Service) GetRepoID() int64

GetRepoID returns the RepoID field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetStarted 

func (s *Service) GetStarted() int64

GetStarted returns the Started field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) GetStatus 

func (s *Service) GetStatus() string

GetStatus returns the Status field.

When the provided Service type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Service) SetBuildID 

func (s *Service) SetBuildID(v int64)

SetBuildID sets the BuildID field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetCreated 

func (s *Service) SetCreated(v int64)

SetCreated sets the Created field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetError 

func (s *Service) SetError(v string)

SetError sets the Error field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetExitCode 

func (s *Service) SetExitCode(v int)

SetExitCode sets the ExitCode field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetFinished 

func (s *Service) SetFinished(v int64)

SetFinished sets the Finished field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetID 

func (s *Service) SetID(v int64)

SetID sets the ID field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetImage added in v0.2.0 

func (s *Service) SetImage(v string)

SetImage sets the Image field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetName 

func (s *Service) SetName(v string)

SetName sets the Name field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetNumber 

func (s *Service) SetNumber(v int)

SetNumber sets the Number field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetRepoID 

func (s *Service) SetRepoID(v int64)

SetRepoID sets the RepoID field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetStarted 

func (s *Service) SetStarted(v int64)

SetStarted sets the Started field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) SetStatus 

func (s *Service) SetStatus(v string)

SetStatus sets the Status field.

When the provided Service type is nil, it will set nothing and immediately return.

func (*Service) String 

func (s *Service) String() string

String implements the Stringer interface for the Service type.

type Step 

type Step struct {
	ID           *int64  `json:"id,omitempty"`
	BuildID      *int64  `json:"build_id,omitempty"`
	RepoID       *int64  `json:"repo_id,omitempty"`
	Number       *int    `json:"number,omitempty"`
	Name         *string `json:"name,omitempty"`
	Image        *string `json:"image,omitempty"`
	Stage        *string `json:"stage,omitempty"`
	Status       *string `json:"status,omitempty"`
	Error        *string `json:"error,omitempty"`
	ExitCode     *int    `json:"exit_code,omitempty"`
	Created      *int64  `json:"created,omitempty"`
	Started      *int64  `json:"started,omitempty"`
	Finished     *int64  `json:"finished,omitempty"`
	Host         *string `json:"host,omitempty"`
	Runtime      *string `json:"runtime,omitempty"`
	Distribution *string `json:"distribution,omitempty"`
}

Step is the library representation of a step in a build.

func StepFromContext 

func StepFromContext(c context.Context) *Step

StepFromContext retrieves the Step type from the context.

func (*Step) GetBuildID 

func (s *Step) GetBuildID() int64

GetBuildID returns the BuildID field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetCreated 

func (s *Step) GetCreated() int64

GetCreated returns the Created field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetDistribution 

func (s *Step) GetDistribution() string

GetDistribution returns the Runtime field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetError 

func (s *Step) GetError() string

GetError returns the Error field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetExitCode 

func (s *Step) GetExitCode() int

GetExitCode returns the ExitCode field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetFinished 

func (s *Step) GetFinished() int64

GetFinished returns the Finished field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetHost 

func (s *Step) GetHost() string

GetHost returns the Host field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetID 

func (s *Step) GetID() int64

GetID returns the ID field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetImage added in v0.2.0 

func (s *Step) GetImage() string

GetImage returns the Image field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetName 

func (s *Step) GetName() string

GetName returns the Name field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetNumber 

func (s *Step) GetNumber() int

GetNumber returns the Number field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetRepoID 

func (s *Step) GetRepoID() int64

GetRepoID returns the RepoID field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetRuntime 

func (s *Step) GetRuntime() string

GetRuntime returns the Runtime field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetStage 

func (s *Step) GetStage() string

GetStage returns the Stage field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetStarted 

func (s *Step) GetStarted() int64

GetStarted returns the Started field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) GetStatus 

func (s *Step) GetStatus() string

GetStatus returns the Status field.

When the provided Step type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*Step) SetBuildID 

func (s *Step) SetBuildID(v int64)

SetBuildID sets the BuildID field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetCreated 

func (s *Step) SetCreated(v int64)

SetCreated sets the Created field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetDistribution 

func (s *Step) SetDistribution(v string)

SetDistribution sets the Runtime field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetError 

func (s *Step) SetError(v string)

SetError sets the Error field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetExitCode 

func (s *Step) SetExitCode(v int)

SetExitCode sets the ExitCode field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetFinished 

func (s *Step) SetFinished(v int64)

SetFinished sets the Finished field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetHost 

func (s *Step) SetHost(v string)

SetHost sets the Host field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetID 

func (s *Step) SetID(v int64)

SetID sets the ID field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetImage added in v0.2.0 

func (s *Step) SetImage(v string)

SetImage sets the Image field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetName 

func (s *Step) SetName(v string)

SetName sets the Name field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetNumber 

func (s *Step) SetNumber(v int)

SetNumber sets the Number field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetRepoID 

func (s *Step) SetRepoID(v int64)

SetRepoID sets the RepoID field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetRuntime 

func (s *Step) SetRuntime(v string)

SetRuntime sets the Runtime field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetStage 

func (s *Step) SetStage(v string)

SetStage sets the Stage field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetStarted 

func (s *Step) SetStarted(v int64)

SetStarted sets the Started field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) SetStatus 

func (s *Step) SetStatus(v string)

SetStatus sets the Status field.

When the provided Step type is nil, it will set nothing and immediately return.

func (*Step) String 

func (s *Step) String() string

String implements the Stringer interface for the Step type.

type User 

type User struct {
	ID        *int64    `json:"id,omitempty"`
	Name      *string   `json:"name,omitempty"`
	Token     *string   `json:"token,omitempty"`
	Hash      *string   `json:"-"`
	Favorites *[]string `json:"favorites,omitempty"`
	Active    *bool     `json:"active,omitempty"`
	Admin     *bool     `json:"admin,omitempty"`
}

User is the library representation of a user.

func UserFromContext 

func UserFromContext(c context.Context) *User

UserFromContext retrieves the User type from the context.

func (*User) GetActive 

func (u *User) GetActive() bool

GetActive returns the Active field.

When the provided User type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*User) GetAdmin 

func (u *User) GetAdmin() bool

GetAdmin returns the Admin field.

When the provided User type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*User) GetFavorites added in v0.3.0 

func (u *User) GetFavorites() []string

GetFavorites returns the Favorites field.

When the provided User type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*User) GetHash 

func (u *User) GetHash() string

GetHash returns the Hash field.

When the provided User type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*User) GetID 

func (u *User) GetID() int64

GetID returns the ID field.

When the provided User type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*User) GetName 

func (u *User) GetName() string

GetName returns the Name field.

When the provided User type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*User) GetToken 

func (u *User) GetToken() string

GetToken returns the Token field.

When the provided User type is nil, or the field within the type is nil, it returns the zero value for the field.

func (*User) SetActive 

func (u *User) SetActive(v bool)

SetActive sets the Active field.

When the provided User type is nil, it will set nothing and immediately return.

func (*User) SetAdmin 

func (u *User) SetAdmin(v bool)

SetAdmin sets the Admin field.

When the provided User type is nil, it will set nothing and immediately return.

func (*User) SetFavorites added in v0.3.0 

func (u *User) SetFavorites(v []string)

SetFavorites sets the Favorites field.

When the provided User type is nil, it will set nothing and immediately return.

func (*User) SetHash 

func (u *User) SetHash(v string)

SetHash sets the Hash field.

When the provided User type is nil, it will set nothing and immediately return.

func (*User) SetID 

func (u *User) SetID(v int64)

SetID sets the ID field.

When the provided User type is nil, it will set nothing and immediately return.

func (*User) SetName 

func (u *User) SetName(v string)

SetName sets the Name field.

When the provided User type is nil, it will set nothing and immediately return.

func (*User) SetToken 

func (u *User) SetToken(v string)

SetToken sets the Token field.

When the provided User type is nil, it will set nothing and immediately return.

func (*User) String 

func (u *User) String() string

String implements the Stringer interface for the User type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.