yaml

Documentation

Overview

package yaml provides definitions for the Cloud Build schema.

Index

• type ArtifactObjects
• type Artifacts
• type AvailableSecrets
• type Config
  • func Parse(r io.Reader) (*Config, error)
  • func ParseBytes(b []byte) (*Config, error)
  • func ParseFile(p string) (*Config, error)
  • func ParseString(s string) (*Config, error)
• type MavenArifact
• type Options
• type Pool
• type PythonPackage
• type Secret
• type SecretManagerSecret
• type Step
• type Volume

Types

type ArtifactObjects

type ArtifactObjects struct {
	Location string   `yaml:"location,omitempty"`
	Paths    []string `yaml:"paths,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#artifactobjects

type Artifacts

type Artifacts struct {
	Objects        *ArtifactObjects `yaml:"objects,omitempty"`
	Mavenartifacts []*MavenArifact  `yaml:"mavenArtifacts,omitempty"`
	Pythonpackages []*PythonPackage `yaml:"pythonPackages,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#artifacts

type AvailableSecrets

type AvailableSecrets struct {
	SecretManager []*SecretManagerSecret `yaml:"secretManager,omitempty"`
	Inline        []*Secret              `yaml:"inline,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#Build.Secrets

type Config

type Config struct {
	Steps            []*Step           `yaml:"steps,omitempty"`
	Timeout          time.Duration     `yaml:"timeout,omitempty"`
	Queuettl         time.Duration     `yaml:"queueTtl,omitempty"`
	Logsbucket       string            `yaml:"logsBucket,omitempty"`
	Options          *Options          `yaml:"options,omitempty"`
	Substitutions    map[string]string `yaml:"substitutions,omitempty"`
	Tags             []string          `yaml:"tags,omitempty"`
	Serviceaccount   string            `yaml:"serviceAccount,omitempty"`
	Secrets          []*Secret         `yaml:"secrets,omitempty"`
	Availablesecrets *AvailableSecrets `yaml:"availableSecrets,omitempty"`
	Artifacts        *Artifacts        `yaml:"artifacts,omitempty"`
	Images           []string          `yaml:"images,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#resource:-build

func Parse

func Parse(r io.Reader) (*Config, error)

Parse parses the configuration from io.Reader r.

func ParseBytes

func ParseBytes(b []byte) (*Config, error)

ParseBytes parses the configuration from bytes b.

func ParseFile

func ParseFile(p string) (*Config, error)

ParseFile parses the configuration from path p.

func ParseString

func ParseString(s string) (*Config, error)

ParseString parses the configuration from string s.

type MavenArifact

type MavenArifact struct {
	Repository string `yaml:"repository,omitempty"`
	Path       string `yaml:"path,omitempty"`
	Artifactid string `yaml:"artifactId,omitempty"`
	Groupid    string `yaml:"groupId,omitempty"`
	Version    string `yaml:"version,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#mavenartifact

type Options

type Options struct {
	Sourceprovenancehash      string    `yaml:"sourceProvenanceHash,omitempty"` // ENUM
	Machinetype               string    `yaml:"machineType,omitempty"`          // ENUM
	Disksizegb                string    `yaml:"diskSizeGb,omitempty"`
	Substitutionoption        string    `yaml:"substitutionOption,omitempty"` // ENUM
	Dynamicsubstitutions      string    `yaml:"dynamicSubstitutions,omitempty"`
	Logstreamingoption        string    `yaml:"logStreamingOption,omitempty"`        // ENUM
	Logging                   string    `yaml:"logging,omitempty"`                   // ENUM
	Defaultlogsbucketbehavior string    `yaml:"defaultLogsBucketBehavior,omitempty"` // ENUM
	Env                       []string  `yaml:"env,omitempty"`
	Secretenv                 []string  `yaml:"secretEnv,omitempty"`
	Volumes                   []*Volume `yaml:"volumes,omitempty"`
	Pool                      *Pool     `yaml:"pool,omitempty"`
	Requestedverifyoption     string    `yaml:"requestedVerifyOption,omitempty"` // ENUM
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#buildoptions

type Pool

type Pool struct {
	Name string `yaml:"name,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#Build.PoolOption

type PythonPackage

type PythonPackage struct {
	Repository string   `yaml:"repository,omitempty"`
	Paths      []string `yaml:"paths,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#pythonpackage

type Secret

type Secret struct {
	KMSKeyName string            `yaml:"kmsKeyName,omitempty"`
	SecretEnv  map[string]string `yaml:"secretEnv,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#secret

type SecretManagerSecret

type SecretManagerSecret struct {
	VersionName string            `yaml:"versionName,omitempty"`
	Env         map[string]string `yaml:"env,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#secretmanagersecret

type Step

type Step struct {
	Name           string        `yaml:"name,omitempty"`
	Args           []string      `yaml:"args,omitempty"`
	Env            []string      `yaml:"env,omitempty"`
	Allowfailure   bool          `yaml:"allowFailure,omitempty"`
	Allowexitcodes []string      `yaml:"allowExitCodes,omitempty"`
	Dir            string        `yaml:"dir,omitempty"`
	ID             string        `yaml:"id,omitempty"`
	Waitfor        []string      `yaml:"waitFor,omitempty"`
	Entrypoint     string        `yaml:"entrypoint,omitempty"`
	Secretenv      string        `yaml:"secretEnv,omitempty"`
	Volumes        []*Volume     `yaml:"volumes,omitempty"`
	Timeout        time.Duration `yaml:"timeout,omitempty"`
	Script         string        `yaml:"script,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#buildstep

type Volume

type Volume struct {
	Name string `yaml:"name,omitempty"`
	Path string `yaml:"path,omitempty"`
}

https://cloud.google.com/build/docs/api/reference/rest/v1/projects.builds#volume