Documentation ¶
Overview ¶
Package cloudbuild provides access to the Cloud Build API.
For product documentation, see: https://cloud.google.com/cloud-build/docs/
Creating a client ¶
Usage example:
import "google.golang.org/api/cloudbuild/v1alpha2" ... ctx := context.Background() cloudbuildService, err := cloudbuild.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
cloudbuildService, err := cloudbuild.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) cloudbuildService, err := cloudbuild.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type ArtifactObjects
- type ArtifactResult
- type Artifacts
- type Build
- type BuildOperationMetadata
- type BuildOptions
- type BuildStep
- type BuiltImage
- type CancelOperationRequest
- type Empty
- type FileHashes
- type HTTPDelivery
- type Hash
- type InlineSecret
- type ListWorkerPoolsResponse
- type NetworkConfig
- type Notification
- type NotifierConfig
- type NotifierMetadata
- type NotifierSecret
- type NotifierSecretRef
- type NotifierSpec
- type Operation
- type ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
- type ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
- type ProjectsLocationsOperationsService
- type ProjectsLocationsService
- type ProjectsService
- type ProjectsWorkerPoolsCreateCall
- func (c *ProjectsWorkerPoolsCreateCall) Context(ctx context.Context) *ProjectsWorkerPoolsCreateCall
- func (c *ProjectsWorkerPoolsCreateCall) Do(opts ...googleapi.CallOption) (*WorkerPool, error)
- func (c *ProjectsWorkerPoolsCreateCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsCreateCall
- func (c *ProjectsWorkerPoolsCreateCall) Header() http.Header
- func (c *ProjectsWorkerPoolsCreateCall) WorkerPoolId(workerPoolId string) *ProjectsWorkerPoolsCreateCall
- type ProjectsWorkerPoolsDeleteCall
- func (c *ProjectsWorkerPoolsDeleteCall) Context(ctx context.Context) *ProjectsWorkerPoolsDeleteCall
- func (c *ProjectsWorkerPoolsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsWorkerPoolsDeleteCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsDeleteCall
- func (c *ProjectsWorkerPoolsDeleteCall) Header() http.Header
- type ProjectsWorkerPoolsGetCall
- func (c *ProjectsWorkerPoolsGetCall) Context(ctx context.Context) *ProjectsWorkerPoolsGetCall
- func (c *ProjectsWorkerPoolsGetCall) Do(opts ...googleapi.CallOption) (*WorkerPool, error)
- func (c *ProjectsWorkerPoolsGetCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsGetCall
- func (c *ProjectsWorkerPoolsGetCall) Header() http.Header
- func (c *ProjectsWorkerPoolsGetCall) IfNoneMatch(entityTag string) *ProjectsWorkerPoolsGetCall
- type ProjectsWorkerPoolsListCall
- func (c *ProjectsWorkerPoolsListCall) Context(ctx context.Context) *ProjectsWorkerPoolsListCall
- func (c *ProjectsWorkerPoolsListCall) Do(opts ...googleapi.CallOption) (*ListWorkerPoolsResponse, error)
- func (c *ProjectsWorkerPoolsListCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsListCall
- func (c *ProjectsWorkerPoolsListCall) Header() http.Header
- func (c *ProjectsWorkerPoolsListCall) IfNoneMatch(entityTag string) *ProjectsWorkerPoolsListCall
- type ProjectsWorkerPoolsPatchCall
- func (c *ProjectsWorkerPoolsPatchCall) Context(ctx context.Context) *ProjectsWorkerPoolsPatchCall
- func (c *ProjectsWorkerPoolsPatchCall) Do(opts ...googleapi.CallOption) (*WorkerPool, error)
- func (c *ProjectsWorkerPoolsPatchCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsPatchCall
- func (c *ProjectsWorkerPoolsPatchCall) Header() http.Header
- func (c *ProjectsWorkerPoolsPatchCall) UpdateMask(updateMask string) *ProjectsWorkerPoolsPatchCall
- type ProjectsWorkerPoolsService
- func (r *ProjectsWorkerPoolsService) Create(parent string, workerpool *WorkerPool) *ProjectsWorkerPoolsCreateCall
- func (r *ProjectsWorkerPoolsService) Delete(name string) *ProjectsWorkerPoolsDeleteCall
- func (r *ProjectsWorkerPoolsService) Get(name string) *ProjectsWorkerPoolsGetCall
- func (r *ProjectsWorkerPoolsService) List(parent string) *ProjectsWorkerPoolsListCall
- func (r *ProjectsWorkerPoolsService) Patch(name string, workerpool *WorkerPool) *ProjectsWorkerPoolsPatchCall
- type RepoSource
- type Results
- type SMTPDelivery
- type Secret
- type SecretManagerSecret
- type Secrets
- type Service
- type SlackDelivery
- type Source
- type SourceProvenance
- type Status
- type StorageSource
- type StorageSourceManifest
- type TimeSpan
- type Volume
- type WorkerConfig
- type WorkerPool
Constants ¶
const (
// See, edit, configure, and delete your Google Cloud Platform data
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArtifactObjects ¶
type ArtifactObjects struct { // Location: Cloud Storage bucket and optional object path, in the form // "gs://bucket/path/to/somewhere/". (see Bucket Name Requirements // (https://cloud.google.com/storage/docs/bucket-naming#requirements)). // Files in the workspace matching any path pattern will be uploaded to // Cloud Storage with this location as a prefix. Location string `json:"location,omitempty"` // Paths: Path globs used to match files in the build's workspace. Paths []string `json:"paths,omitempty"` // Timing: Output only. Stores timing information for pushing all // artifact objects. Timing *TimeSpan `json:"timing,omitempty"` // ForceSendFields is a list of field names (e.g. "Location") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Location") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ArtifactObjects: Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.
func (*ArtifactObjects) MarshalJSON ¶
func (s *ArtifactObjects) MarshalJSON() ([]byte, error)
type ArtifactResult ¶
type ArtifactResult struct { // FileHash: The file hash of the artifact. FileHash []*FileHashes `json:"fileHash,omitempty"` // Location: The path of an artifact in a Google Cloud Storage bucket, // with the generation number. For example, // `gs://mybucket/path/to/output.jar#generation`. Location string `json:"location,omitempty"` // ForceSendFields is a list of field names (e.g. "FileHash") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FileHash") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ArtifactResult: An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.
func (*ArtifactResult) MarshalJSON ¶
func (s *ArtifactResult) MarshalJSON() ([]byte, error)
type Artifacts ¶
type Artifacts struct { // Images: A list of images to be pushed upon the successful completion // of all build steps. The images will be pushed using the builder // service account's credentials. The digests of the pushed images will // be stored in the Build resource's results field. If any of the images // fail to be pushed, the build is marked FAILURE. Images []string `json:"images,omitempty"` // Objects: A list of objects to be uploaded to Cloud Storage upon // successful completion of all build steps. Files in the workspace // matching specified paths globs will be uploaded to the specified // Cloud Storage location using the builder service account's // credentials. The location and generation of the uploaded objects will // be stored in the Build resource's results field. If any objects fail // to be pushed, the build is marked FAILURE. Objects *ArtifactObjects `json:"objects,omitempty"` // ForceSendFields is a list of field names (e.g. "Images") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Images") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Artifacts: Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
func (*Artifacts) MarshalJSON ¶
type Build ¶
type Build struct { // Artifacts: Artifacts produced by the build that should be uploaded // upon successful completion of all build steps. Artifacts *Artifacts `json:"artifacts,omitempty"` // AvailableSecrets: Secrets and secret environment variables. AvailableSecrets *Secrets `json:"availableSecrets,omitempty"` // BuildTriggerId: Output only. The ID of the `BuildTrigger` that // triggered this build, if it was triggered automatically. BuildTriggerId string `json:"buildTriggerId,omitempty"` // CreateTime: Output only. Time at which the request to create the // build was received. CreateTime string `json:"createTime,omitempty"` // FinishTime: Output only. Time at which execution of the build was // finished. The difference between finish_time and start_time is the // duration of the build's execution. FinishTime string `json:"finishTime,omitempty"` // Id: Output only. Unique identifier of the build. Id string `json:"id,omitempty"` // Images: A list of images to be pushed upon the successful completion // of all build steps. The images are pushed using the builder service // account's credentials. The digests of the pushed images will be // stored in the `Build` resource's results field. If any of the images // fail to be pushed, the build status is marked `FAILURE`. Images []string `json:"images,omitempty"` // LogUrl: Output only. URL to logs for this build in Google Cloud // Console. LogUrl string `json:"logUrl,omitempty"` // LogsBucket: Google Cloud Storage bucket where logs should be written // (see Bucket Name Requirements // (https://cloud.google.com/storage/docs/bucket-naming#requirements)). // Logs file names will be of the format // `${logs_bucket}/log-${build_id}.txt`. LogsBucket string `json:"logsBucket,omitempty"` // Name: Output only. The 'Build' name with format: // `projects/{project}/locations/{location}/builds/{build}`, where // {build} is a unique identifier generated by the service. Name string `json:"name,omitempty"` // Options: Special options for this build. Options *BuildOptions `json:"options,omitempty"` // ProjectId: Output only. ID of the project. ProjectId string `json:"projectId,omitempty"` // QueueTtl: TTL in queue for this build. If provided and the build is // enqueued longer than this value, the build will expire and the build // status will be `EXPIRED`. The TTL starts ticking from create_time. QueueTtl string `json:"queueTtl,omitempty"` // Results: Output only. Results of the build. Results *Results `json:"results,omitempty"` // Secrets: Secrets to decrypt using Cloud Key Management Service. Note: // Secret Manager is the recommended technique for managing sensitive // data with Cloud Build. Use `available_secrets` to configure builds to // access secrets from Secret Manager. For instructions, see: // https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets Secrets []*Secret `json:"secrets,omitempty"` // ServiceAccount: IAM service account whose credentials will be used at // build runtime. Must be of the format // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be // email address or uniqueId of the service account. This field is in // beta. ServiceAccount string `json:"serviceAccount,omitempty"` // Source: The location of the source files to build. Source *Source `json:"source,omitempty"` // SourceProvenance: Output only. A permanent fixed identifier for // source. SourceProvenance *SourceProvenance `json:"sourceProvenance,omitempty"` // StartTime: Output only. Time at which execution of the build was // started. StartTime string `json:"startTime,omitempty"` // Status: Output only. Status of the build. // // Possible values: // "STATUS_UNKNOWN" - Status of the build is unknown. // "QUEUED" - Build or step is queued; work has not yet begun. // "WORKING" - Build or step is being executed. // "SUCCESS" - Build or step finished successfully. // "FAILURE" - Build or step failed to complete successfully. // "INTERNAL_ERROR" - Build or step failed due to an internal cause. // "TIMEOUT" - Build or step took longer than was allowed. // "CANCELLED" - Build or step was canceled by a user. // "EXPIRED" - Build was enqueued for longer than the value of // `queue_ttl`. Status string `json:"status,omitempty"` // StatusDetail: Output only. Customer-readable message about the // current status. StatusDetail string `json:"statusDetail,omitempty"` // Steps: Required. The operations to be performed on the workspace. Steps []*BuildStep `json:"steps,omitempty"` // Substitutions: Substitutions data for `Build` resource. Substitutions map[string]string `json:"substitutions,omitempty"` // Tags: Tags for annotation of a `Build`. These are not docker tags. Tags []string `json:"tags,omitempty"` // Timeout: Amount of time that this build should be allowed to run, to // second granularity. If this amount of time elapses, work on the build // will cease and the build status will be `TIMEOUT`. `timeout` starts // ticking from `startTime`. Default time is ten minutes. Timeout string `json:"timeout,omitempty"` // Timing: Output only. Stores timing information for phases of the // build. Valid keys are: * BUILD: time to execute all build steps * // PUSH: time to push all specified images. * FETCHSOURCE: time to fetch // source. If the build does not specify source or images, these keys // will not be included. Timing map[string]TimeSpan `json:"timing,omitempty"` // ForceSendFields is a list of field names (e.g. "Artifacts") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Artifacts") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Build: A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
func (*Build) MarshalJSON ¶
type BuildOperationMetadata ¶
type BuildOperationMetadata struct { // Build: The build that the operation is tracking. Build *Build `json:"build,omitempty"` // ForceSendFields is a list of field names (e.g. "Build") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Build") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildOperationMetadata: Metadata for build operations.
func (*BuildOperationMetadata) MarshalJSON ¶
func (s *BuildOperationMetadata) MarshalJSON() ([]byte, error)
type BuildOptions ¶
type BuildOptions struct { // DiskSizeGb: Requested disk size for the VM that runs the build. Note // that this is *NOT* "disk free"; some of the space will be used by the // operating system and build utilities. Also note that this is the // minimum disk size that will be allocated for the build -- the build // may run with a larger disk than requested. At present, the maximum // disk size is 1000GB; builds that request more than the maximum are // rejected with an error. DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"` // DynamicSubstitutions: Option to specify whether or not to apply bash // style string operations to the substitutions. NOTE: this is always // enabled for triggered builds and cannot be overridden in the build // configuration file. DynamicSubstitutions bool `json:"dynamicSubstitutions,omitempty"` // Env: A list of global environment variable definitions that will // exist for all build steps in this build. If a variable is defined in // both globally and in a build step, the variable will use the build // step value. The elements are of the form "KEY=VALUE" for the // environment variable "KEY" being given the value "VALUE". Env []string `json:"env,omitempty"` // LogStreamingOption: Option to define build log streaming behavior to // Google Cloud Storage. // // Possible values: // "STREAM_DEFAULT" - Service may automatically determine build log // streaming behavior. // "STREAM_ON" - Build logs should be streamed to Google Cloud // Storage. // "STREAM_OFF" - Build logs should not be streamed to Google Cloud // Storage; they will be written when the build is completed. LogStreamingOption string `json:"logStreamingOption,omitempty"` // Logging: Option to specify the logging mode, which determines if and // where build logs are stored. // // Possible values: // "LOGGING_UNSPECIFIED" - The service determines the logging mode. // The default is `LEGACY`. Do not rely on the default logging behavior // as it may change in the future. // "LEGACY" - Cloud Logging and Cloud Storage logging are enabled. // "GCS_ONLY" - Only Cloud Storage logging is enabled. // "STACKDRIVER_ONLY" - This option is the same as CLOUD_LOGGING_ONLY. // "CLOUD_LOGGING_ONLY" - Only Cloud Logging is enabled. Note that // logs for both the Cloud Console UI and Cloud SDK are based on Cloud // Storage logs, so neither will provide logs if this option is chosen. // "NONE" - Turn off all logging. No build logs will be captured. Logging string `json:"logging,omitempty"` // MachineType: Compute Engine machine type on which to run the build. // // Possible values: // "UNSPECIFIED" - Standard machine type. // "N1_HIGHCPU_8" - Highcpu machine with 8 CPUs. // "N1_HIGHCPU_32" - Highcpu machine with 32 CPUs. // "E2_HIGHCPU_8" - Highcpu e2 machine with 8 CPUs. // "E2_HIGHCPU_32" - Highcpu e2 machine with 32 CPUs. MachineType string `json:"machineType,omitempty"` // RequestedVerifyOption: Requested verifiability options. // // Possible values: // "NOT_VERIFIED" - Not a verifiable build. (default) // "VERIFIED" - Verified build. RequestedVerifyOption string `json:"requestedVerifyOption,omitempty"` // SecretEnv: A list of global environment variables, which are // encrypted using a Cloud Key Management Service crypto key. These // values must be specified in the build's `Secret`. These variables // will be available to all build steps in this build. SecretEnv []string `json:"secretEnv,omitempty"` // SourceProvenanceHash: Requested hash for SourceProvenance. // // Possible values: // "NONE" - No hash requested. // "SHA256" - Use a sha256 hash. // "MD5" - Use a md5 hash. SourceProvenanceHash []string `json:"sourceProvenanceHash,omitempty"` // SubstitutionOption: Option to specify behavior when there is an error // in the substitution checks. NOTE: this is always set to ALLOW_LOOSE // for triggered builds and cannot be overridden in the build // configuration file. // // Possible values: // "MUST_MATCH" - Fails the build if error in substitutions checks, // like missing a substitution in the template or in the map. // "ALLOW_LOOSE" - Do not fail the build if error in substitutions // checks. SubstitutionOption string `json:"substitutionOption,omitempty"` // Volumes: Global list of volumes to mount for ALL build steps Each // volume is created as an empty volume prior to starting the build // process. Upon completion of the build, volumes and their contents are // discarded. Global volume names and paths cannot conflict with the // volumes defined a build step. Using a global volume in a build with // only one step is not valid as it is indicative of a build request // with an incorrect configuration. Volumes []*Volume `json:"volumes,omitempty"` // WorkerPool: Option to specify a `WorkerPool` for the build. Format: // projects/{project}/locations/{location}/workerPools/{workerPool} This // field is in beta and is available only to restricted users. WorkerPool string `json:"workerPool,omitempty"` // ForceSendFields is a list of field names (e.g. "DiskSizeGb") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DiskSizeGb") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildOptions: Optional arguments to enable specific features of builds.
func (*BuildOptions) MarshalJSON ¶
func (s *BuildOptions) MarshalJSON() ([]byte, error)
type BuildStep ¶
type BuildStep struct { // Args: A list of arguments that will be presented to the step when it // is started. If the image used to run the step's container has an // entrypoint, the `args` are used as arguments to that entrypoint. If // the image does not define an entrypoint, the first element in args is // used as the entrypoint, and the remainder will be used as arguments. Args []string `json:"args,omitempty"` // Dir: Working directory to use when running this step's container. If // this value is a relative path, it is relative to the build's working // directory. If this value is absolute, it may be outside the build's // working directory, in which case the contents of the path may not be // persisted across build step executions, unless a `volume` for that // path is specified. If the build specifies a `RepoSource` with `dir` // and a step with a `dir`, which specifies an absolute path, the // `RepoSource` `dir` is ignored for the step's execution. Dir string `json:"dir,omitempty"` // Entrypoint: Entrypoint to be used instead of the build step image's // default entrypoint. If unset, the image's default entrypoint is used. Entrypoint string `json:"entrypoint,omitempty"` // Env: A list of environment variable definitions to be used when // running a step. The elements are of the form "KEY=VALUE" for the // environment variable "KEY" being given the value "VALUE". Env []string `json:"env,omitempty"` // Id: Unique identifier for this build step, used in `wait_for` to // reference this build step as a dependency. Id string `json:"id,omitempty"` // Name: Required. The name of the container image that will run this // particular build step. If the image is available in the host's Docker // daemon's cache, it will be run directly. If not, the host will // attempt to pull the image first, using the builder service account's // credentials if necessary. The Docker daemon's cache will already have // the latest versions of all of the officially supported build steps // (https://github.com/GoogleCloudPlatform/cloud-builders // (https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker // daemon will also have cached many of the layers for some popular // images, like "ubuntu", "debian", but they will be refreshed at the // time you attempt to use them. If you built an image in a previous // build step, it will be stored in the host's Docker daemon's cache and // is available to use as the name for a later build step. Name string `json:"name,omitempty"` // PullTiming: Output only. Stores timing information for pulling this // build step's builder image only. PullTiming *TimeSpan `json:"pullTiming,omitempty"` // SecretEnv: A list of environment variables which are encrypted using // a Cloud Key Management Service crypto key. These values must be // specified in the build's `Secret`. SecretEnv []string `json:"secretEnv,omitempty"` // Status: Output only. Status of the build step. At this time, build // step status is only updated on build completion; step status is not // updated in real-time as the build progresses. // // Possible values: // "STATUS_UNKNOWN" - Status of the build is unknown. // "QUEUED" - Build or step is queued; work has not yet begun. // "WORKING" - Build or step is being executed. // "SUCCESS" - Build or step finished successfully. // "FAILURE" - Build or step failed to complete successfully. // "INTERNAL_ERROR" - Build or step failed due to an internal cause. // "TIMEOUT" - Build or step took longer than was allowed. // "CANCELLED" - Build or step was canceled by a user. // "EXPIRED" - Build was enqueued for longer than the value of // `queue_ttl`. Status string `json:"status,omitempty"` // Timeout: Time limit for executing this build step. If not defined, // the step has no time limit and will be allowed to continue to run // until either it completes or the build itself times out. Timeout string `json:"timeout,omitempty"` // Timing: Output only. Stores timing information for executing this // build step. Timing *TimeSpan `json:"timing,omitempty"` // Volumes: List of volumes to mount into the build step. Each volume is // created as an empty volume prior to execution of the build step. Upon // completion of the build, volumes and their contents are discarded. // Using a named volume in only one step is not valid as it is // indicative of a build request with an incorrect configuration. Volumes []*Volume `json:"volumes,omitempty"` // WaitFor: The ID(s) of the step(s) that this build step depends on. // This build step will not start until all the build steps in // `wait_for` have completed successfully. If `wait_for` is empty, this // build step will start when all previous build steps in the // `Build.Steps` list have completed successfully. WaitFor []string `json:"waitFor,omitempty"` // ForceSendFields is a list of field names (e.g. "Args") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Args") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildStep: A step in the build pipeline.
func (*BuildStep) MarshalJSON ¶
type BuiltImage ¶
type BuiltImage struct { // Digest: Docker Registry 2.0 digest. Digest string `json:"digest,omitempty"` // Name: Name used to push the container image to Google Container // Registry, as presented to `docker push`. Name string `json:"name,omitempty"` // PushTiming: Output only. Stores timing information for pushing the // specified image. PushTiming *TimeSpan `json:"pushTiming,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuiltImage: An image built by the pipeline.
func (*BuiltImage) MarshalJSON ¶
func (s *BuiltImage) MarshalJSON() ([]byte, error)
type CancelOperationRequest ¶ added in v0.26.0
type CancelOperationRequest struct { }
CancelOperationRequest: The request message for Operations.CancelOperation.
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
type FileHashes ¶
type FileHashes struct { // FileHash: Collection of file hashes. FileHash []*Hash `json:"fileHash,omitempty"` // ForceSendFields is a list of field names (e.g. "FileHash") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FileHash") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
FileHashes: Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
func (*FileHashes) MarshalJSON ¶
func (s *FileHashes) MarshalJSON() ([]byte, error)
type HTTPDelivery ¶ added in v0.29.0
type HTTPDelivery struct { // Uri: The URI to which JSON-containing HTTP POST requests should be // sent. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Uri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Uri") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HTTPDelivery: HTTPDelivery is the delivery configuration for an HTTP notification.
func (*HTTPDelivery) MarshalJSON ¶ added in v0.29.0
func (s *HTTPDelivery) MarshalJSON() ([]byte, error)
type Hash ¶
type Hash struct { // Type: The type of hash that was performed. // // Possible values: // "NONE" - No hash requested. // "SHA256" - Use a sha256 hash. // "MD5" - Use a md5 hash. Type string `json:"type,omitempty"` // Value: The hash value. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Type") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Hash: Container message for hash values.
func (*Hash) MarshalJSON ¶
type InlineSecret ¶ added in v0.38.0
type InlineSecret struct { // EnvMap: Map of environment variable name to its encrypted value. // Secret environment variables must be unique across all of a build's // secrets, and must be used by at least one build step. Values can be // at most 64 KB in size. There can be at most 100 secret values across // all of a build's secrets. EnvMap map[string]string `json:"envMap,omitempty"` // KmsKeyName: Resource name of Cloud KMS crypto key to decrypt the // encrypted value. In format: // projects/*/locations/*/keyRings/*/cryptoKeys/* KmsKeyName string `json:"kmsKeyName,omitempty"` // ForceSendFields is a list of field names (e.g. "EnvMap") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EnvMap") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
InlineSecret: Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
func (*InlineSecret) MarshalJSON ¶ added in v0.38.0
func (s *InlineSecret) MarshalJSON() ([]byte, error)
type ListWorkerPoolsResponse ¶
type ListWorkerPoolsResponse struct { // WorkerPools: `WorkerPools` for the specified project. WorkerPools []*WorkerPool `json:"workerPools,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "WorkerPools") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "WorkerPools") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListWorkerPoolsResponse: Response containing existing `WorkerPools`.
func (*ListWorkerPoolsResponse) MarshalJSON ¶
func (s *ListWorkerPoolsResponse) MarshalJSON() ([]byte, error)
type NetworkConfig ¶
type NetworkConfig struct { // PeeredNetwork: Required. Immutable. The network definition that the // workers are peered to. If this section is left empty, the workers // will be peered to WorkerPool.project_id on the default network. Must // be in the format `projects/{project}/global/networks/{network}`, // where {project} is a project number, such as `12345`, and {network} // is the name of a VPC network in the project. PeeredNetwork string `json:"peeredNetwork,omitempty"` // ForceSendFields is a list of field names (e.g. "PeeredNetwork") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "PeeredNetwork") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NetworkConfig: Network describes the network configuration for a `WorkerPool`.
func (*NetworkConfig) MarshalJSON ¶
func (s *NetworkConfig) MarshalJSON() ([]byte, error)
type Notification ¶ added in v0.29.0
type Notification struct { // Filter: The filter string to use for notification filtering. // Currently, this is assumed to be a CEL program. See // https://opensource.google/projects/cel for more. Filter string `json:"filter,omitempty"` // HttpDelivery: Configuration for HTTP delivery. HttpDelivery *HTTPDelivery `json:"httpDelivery,omitempty"` // SlackDelivery: Configuration for Slack delivery. SlackDelivery *SlackDelivery `json:"slackDelivery,omitempty"` // SmtpDelivery: Configuration for SMTP (email) delivery. SmtpDelivery *SMTPDelivery `json:"smtpDelivery,omitempty"` // StructDelivery: Escape hatch for users to supply custom delivery // configs. StructDelivery googleapi.RawMessage `json:"structDelivery,omitempty"` // ForceSendFields is a list of field names (e.g. "Filter") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Filter") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Notification: Notification is the container which holds the data that is relevant to this particular notification.
func (*Notification) MarshalJSON ¶ added in v0.29.0
func (s *Notification) MarshalJSON() ([]byte, error)
type NotifierConfig ¶ added in v0.29.0
type NotifierConfig struct { // ApiVersion: The API version of this configuration format. ApiVersion string `json:"apiVersion,omitempty"` // Kind: The type of notifier to use (e.g. SMTPNotifier). Kind string `json:"kind,omitempty"` // Metadata: Metadata for referring to/handling/deploying this notifier. Metadata *NotifierMetadata `json:"metadata,omitempty"` // Spec: The actual configuration for this notifier. Spec *NotifierSpec `json:"spec,omitempty"` // ForceSendFields is a list of field names (e.g. "ApiVersion") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ApiVersion") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NotifierConfig: NotifierConfig is the top-level configuration message.
func (*NotifierConfig) MarshalJSON ¶ added in v0.29.0
func (s *NotifierConfig) MarshalJSON() ([]byte, error)
type NotifierMetadata ¶ added in v0.29.0
type NotifierMetadata struct { // Name: The human-readable and user-given name for the notifier. For // example: "repo-merge-email-notifier". Name string `json:"name,omitempty"` // Notifier: The string representing the name and version of notifier to // deploy. Expected to be of the form of "/:". For example: // "gcr.io/my-project/notifiers/smtp:1.2.34". Notifier string `json:"notifier,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NotifierMetadata: NotifierMetadata contains the data which can be used to reference or describe this notifier.
func (*NotifierMetadata) MarshalJSON ¶ added in v0.29.0
func (s *NotifierMetadata) MarshalJSON() ([]byte, error)
type NotifierSecret ¶ added in v0.29.0
type NotifierSecret struct { // Name: Name is the local name of the secret, such as the verbatim // string "my-smtp-password". Name string `json:"name,omitempty"` // Value: Value is interpreted to be a resource path for fetching the // actual (versioned) secret data for this secret. For example, this // would be a Google Cloud Secret Manager secret version resource path // like: "projects/my-project/secrets/my-secret/versions/latest". Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NotifierSecret: NotifierSecret is the container that maps a secret name (reference) to its Google Cloud Secret Manager resource path.
func (*NotifierSecret) MarshalJSON ¶ added in v0.29.0
func (s *NotifierSecret) MarshalJSON() ([]byte, error)
type NotifierSecretRef ¶ added in v0.29.0
type NotifierSecretRef struct { // SecretRef: The value of `secret_ref` should be a `name` that is // registered in a `Secret` in the `secrets` list of the `Spec`. SecretRef string `json:"secretRef,omitempty"` // ForceSendFields is a list of field names (e.g. "SecretRef") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "SecretRef") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NotifierSecretRef: NotifierSecretRef contains the reference to a secret stored in the corresponding NotifierSpec.
func (*NotifierSecretRef) MarshalJSON ¶ added in v0.29.0
func (s *NotifierSecretRef) MarshalJSON() ([]byte, error)
type NotifierSpec ¶ added in v0.29.0
type NotifierSpec struct { // Notification: The configuration of this particular notifier. Notification *Notification `json:"notification,omitempty"` // Secrets: Configurations for secret resources used by this particular // notifier. Secrets []*NotifierSecret `json:"secrets,omitempty"` // ForceSendFields is a list of field names (e.g. "Notification") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Notification") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
NotifierSpec: NotifierSpec is the configuration container for notifications.
func (*NotifierSpec) MarshalJSON ¶ added in v0.29.0
func (s *NotifierSpec) MarshalJSON() ([]byte, error)
type Operation ¶ added in v0.26.0
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. If `true`, the operation is completed, and either `error` // or `response` is available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. It // typically contains progress information and common metadata such as // create time. Some services might not provide such metadata. Any // method that returns a long-running operation should document the // metadata type, if any. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that originally returns it. If you use the default HTTP // mapping, the `name` should be a resource name ending with // `operations/{unique_id}`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. If // the original method returns no data on success, such as `Delete`, the // response is `google.protobuf.Empty`. If the original method is // standard `Get`/`Create`/`Update`, the response should be the // resource. For other methods, the response should have the type // `XxxResponse`, where `Xxx` is the original method name. For example, // if the original method name is `TakeSnapshot()`, the inferred // response type is `TakeSnapshotResponse`. Response googleapi.RawMessage `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Done") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶ added in v0.26.0
type ProjectsLocationsOperationsCancelCall ¶ added in v0.26.0
type ProjectsLocationsOperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsCancelCall) Context ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsCancelCall) Do ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudbuild.projects.locations.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsCancelCall) Fields ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsCancelCall) Header ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsLocationsOperationsGetCall ¶ added in v0.26.0
type ProjectsLocationsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsGetCall) Context ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsGetCall) Do ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudbuild.projects.locations.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsGetCall) Fields ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsGetCall) Header ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsGetCall) IfNoneMatch ¶ added in v0.26.0
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsOperationsService ¶ added in v0.26.0
type ProjectsLocationsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsOperationsService ¶ added in v0.26.0
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
func (*ProjectsLocationsOperationsService) Cancel ¶ added in v0.26.0
func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
func (*ProjectsLocationsOperationsService) Get ¶ added in v0.26.0
func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
type ProjectsLocationsService ¶ added in v0.26.0
type ProjectsLocationsService struct { Operations *ProjectsLocationsOperationsService // contains filtered or unexported fields }
func NewProjectsLocationsService ¶ added in v0.26.0
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
type ProjectsService ¶
type ProjectsService struct { Locations *ProjectsLocationsService WorkerPools *ProjectsWorkerPoolsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type ProjectsWorkerPoolsCreateCall ¶
type ProjectsWorkerPoolsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsWorkerPoolsCreateCall) Context ¶
func (c *ProjectsWorkerPoolsCreateCall) Context(ctx context.Context) *ProjectsWorkerPoolsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsWorkerPoolsCreateCall) Do ¶
func (c *ProjectsWorkerPoolsCreateCall) Do(opts ...googleapi.CallOption) (*WorkerPool, error)
Do executes the "cloudbuild.projects.workerPools.create" call. Exactly one of *WorkerPool or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WorkerPool.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsWorkerPoolsCreateCall) Fields ¶
func (c *ProjectsWorkerPoolsCreateCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsWorkerPoolsCreateCall) Header ¶
func (c *ProjectsWorkerPoolsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsWorkerPoolsCreateCall) WorkerPoolId ¶
func (c *ProjectsWorkerPoolsCreateCall) WorkerPoolId(workerPoolId string) *ProjectsWorkerPoolsCreateCall
WorkerPoolId sets the optional parameter "workerPoolId": Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
type ProjectsWorkerPoolsDeleteCall ¶
type ProjectsWorkerPoolsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsWorkerPoolsDeleteCall) Context ¶
func (c *ProjectsWorkerPoolsDeleteCall) Context(ctx context.Context) *ProjectsWorkerPoolsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsWorkerPoolsDeleteCall) Do ¶
func (c *ProjectsWorkerPoolsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudbuild.projects.workerPools.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsWorkerPoolsDeleteCall) Fields ¶
func (c *ProjectsWorkerPoolsDeleteCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsWorkerPoolsDeleteCall) Header ¶
func (c *ProjectsWorkerPoolsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsWorkerPoolsGetCall ¶
type ProjectsWorkerPoolsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsWorkerPoolsGetCall) Context ¶
func (c *ProjectsWorkerPoolsGetCall) Context(ctx context.Context) *ProjectsWorkerPoolsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsWorkerPoolsGetCall) Do ¶
func (c *ProjectsWorkerPoolsGetCall) Do(opts ...googleapi.CallOption) (*WorkerPool, error)
Do executes the "cloudbuild.projects.workerPools.get" call. Exactly one of *WorkerPool or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WorkerPool.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsWorkerPoolsGetCall) Fields ¶
func (c *ProjectsWorkerPoolsGetCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsWorkerPoolsGetCall) Header ¶
func (c *ProjectsWorkerPoolsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsWorkerPoolsGetCall) IfNoneMatch ¶
func (c *ProjectsWorkerPoolsGetCall) IfNoneMatch(entityTag string) *ProjectsWorkerPoolsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsWorkerPoolsListCall ¶
type ProjectsWorkerPoolsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsWorkerPoolsListCall) Context ¶
func (c *ProjectsWorkerPoolsListCall) Context(ctx context.Context) *ProjectsWorkerPoolsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsWorkerPoolsListCall) Do ¶
func (c *ProjectsWorkerPoolsListCall) Do(opts ...googleapi.CallOption) (*ListWorkerPoolsResponse, error)
Do executes the "cloudbuild.projects.workerPools.list" call. Exactly one of *ListWorkerPoolsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListWorkerPoolsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsWorkerPoolsListCall) Fields ¶
func (c *ProjectsWorkerPoolsListCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsWorkerPoolsListCall) Header ¶
func (c *ProjectsWorkerPoolsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsWorkerPoolsListCall) IfNoneMatch ¶
func (c *ProjectsWorkerPoolsListCall) IfNoneMatch(entityTag string) *ProjectsWorkerPoolsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsWorkerPoolsPatchCall ¶
type ProjectsWorkerPoolsPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsWorkerPoolsPatchCall) Context ¶
func (c *ProjectsWorkerPoolsPatchCall) Context(ctx context.Context) *ProjectsWorkerPoolsPatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsWorkerPoolsPatchCall) Do ¶
func (c *ProjectsWorkerPoolsPatchCall) Do(opts ...googleapi.CallOption) (*WorkerPool, error)
Do executes the "cloudbuild.projects.workerPools.patch" call. Exactly one of *WorkerPool or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WorkerPool.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsWorkerPoolsPatchCall) Fields ¶
func (c *ProjectsWorkerPoolsPatchCall) Fields(s ...googleapi.Field) *ProjectsWorkerPoolsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsWorkerPoolsPatchCall) Header ¶
func (c *ProjectsWorkerPoolsPatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsWorkerPoolsPatchCall) UpdateMask ¶
func (c *ProjectsWorkerPoolsPatchCall) UpdateMask(updateMask string) *ProjectsWorkerPoolsPatchCall
UpdateMask sets the optional parameter "updateMask": A mask specifying which fields in `WorkerPool` should be updated.
type ProjectsWorkerPoolsService ¶
type ProjectsWorkerPoolsService struct {
// contains filtered or unexported fields
}
func NewProjectsWorkerPoolsService ¶
func NewProjectsWorkerPoolsService(s *Service) *ProjectsWorkerPoolsService
func (*ProjectsWorkerPoolsService) Create ¶
func (r *ProjectsWorkerPoolsService) Create(parent string, workerpool *WorkerPool) *ProjectsWorkerPoolsCreateCall
Create: Creates a `WorkerPool` to run the builds, and returns the new worker pool.
func (*ProjectsWorkerPoolsService) Delete ¶
func (r *ProjectsWorkerPoolsService) Delete(name string) *ProjectsWorkerPoolsDeleteCall
Delete: Deletes a `WorkerPool`.
func (*ProjectsWorkerPoolsService) Get ¶
func (r *ProjectsWorkerPoolsService) Get(name string) *ProjectsWorkerPoolsGetCall
Get: Returns details of a `WorkerPool`.
func (*ProjectsWorkerPoolsService) List ¶
func (r *ProjectsWorkerPoolsService) List(parent string) *ProjectsWorkerPoolsListCall
List: Lists `WorkerPool`s by project.
func (*ProjectsWorkerPoolsService) Patch ¶
func (r *ProjectsWorkerPoolsService) Patch(name string, workerpool *WorkerPool) *ProjectsWorkerPoolsPatchCall
Patch: Updates a `WorkerPool`.
type RepoSource ¶
type RepoSource struct { // BranchName: Regex matching branches to build. The syntax of the // regular expressions accepted is the syntax accepted by RE2 and // described at https://github.com/google/re2/wiki/Syntax BranchName string `json:"branchName,omitempty"` // CommitSha: Explicit commit SHA to build. CommitSha string `json:"commitSha,omitempty"` // Dir: Directory, relative to the source root, in which to run the // build. This must be a relative path. If a step's `dir` is specified // and is an absolute path, this value is ignored for that step's // execution. Dir string `json:"dir,omitempty"` // InvertRegex: Only trigger a build if the revision regex does NOT // match the revision regex. InvertRegex bool `json:"invertRegex,omitempty"` // ProjectId: ID of the project that owns the Cloud Source Repository. // If omitted, the project ID requesting the build is assumed. ProjectId string `json:"projectId,omitempty"` // RepoName: Name of the Cloud Source Repository. RepoName string `json:"repoName,omitempty"` // Substitutions: Substitutions to use in a triggered build. Should only // be used with RunBuildTrigger Substitutions map[string]string `json:"substitutions,omitempty"` // TagName: Regex matching tags to build. The syntax of the regular // expressions accepted is the syntax accepted by RE2 and described at // https://github.com/google/re2/wiki/Syntax TagName string `json:"tagName,omitempty"` // ForceSendFields is a list of field names (e.g. "BranchName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BranchName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
RepoSource: Location of the source in a Google Cloud Source Repository.
func (*RepoSource) MarshalJSON ¶
func (s *RepoSource) MarshalJSON() ([]byte, error)
type Results ¶
type Results struct { // ArtifactManifest: Path to the artifact manifest. Only populated when // artifacts are uploaded. ArtifactManifest string `json:"artifactManifest,omitempty"` // ArtifactTiming: Time to push all non-container artifacts. ArtifactTiming *TimeSpan `json:"artifactTiming,omitempty"` // BuildStepImages: List of build step digests, in the order // corresponding to build step indices. BuildStepImages []string `json:"buildStepImages,omitempty"` // BuildStepOutputs: List of build step outputs, produced by builder // images, in the order corresponding to build step indices. Cloud // Builders (https://cloud.google.com/cloud-build/docs/cloud-builders) // can produce this output by writing to `$BUILDER_OUTPUT/output`. Only // the first 4KB of data is stored. BuildStepOutputs []string `json:"buildStepOutputs,omitempty"` // Images: Container images that were built as a part of the build. Images []*BuiltImage `json:"images,omitempty"` // NumArtifacts: Number of artifacts uploaded. Only populated when // artifacts are uploaded. NumArtifacts int64 `json:"numArtifacts,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ArtifactManifest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ArtifactManifest") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Results: Artifacts created by the build pipeline.
func (*Results) MarshalJSON ¶
type SMTPDelivery ¶ added in v0.29.0
type SMTPDelivery struct { // FromAddress: This is the SMTP account/email that appears in the // `From:` of the email. If empty, it is assumed to be sender. FromAddress string `json:"fromAddress,omitempty"` // Password: The SMTP sender's password. Password *NotifierSecretRef `json:"password,omitempty"` // Port: The SMTP port of the server. Port string `json:"port,omitempty"` // RecipientAddresses: This is the list of addresses to which we send // the email (i.e. in the `To:` of the email). RecipientAddresses []string `json:"recipientAddresses,omitempty"` // SenderAddress: This is the SMTP account/email that is used to send // the message. SenderAddress string `json:"senderAddress,omitempty"` // Server: The address of the SMTP server. Server string `json:"server,omitempty"` // ForceSendFields is a list of field names (e.g. "FromAddress") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FromAddress") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SMTPDelivery: SMTPDelivery is the delivery configuration for an SMTP (email) notification.
func (*SMTPDelivery) MarshalJSON ¶ added in v0.29.0
func (s *SMTPDelivery) MarshalJSON() ([]byte, error)
type Secret ¶
type Secret struct { // KmsKeyName: Cloud KMS key name to use to decrypt these envs. KmsKeyName string `json:"kmsKeyName,omitempty"` // SecretEnv: Map of environment variable name to its encrypted value. // Secret environment variables must be unique across all of a build's // secrets, and must be used by at least one build step. Values can be // at most 64 KB in size. There can be at most 100 secret values across // all of a build's secrets. SecretEnv map[string]string `json:"secretEnv,omitempty"` // ForceSendFields is a list of field names (e.g. "KmsKeyName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "KmsKeyName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Secret: Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.
func (*Secret) MarshalJSON ¶
type SecretManagerSecret ¶ added in v0.38.0
type SecretManagerSecret struct { // Env: Environment variable name to associate with the secret. Secret // environment variables must be unique across all of a build's secrets, // and must be used by at least one build step. Env string `json:"env,omitempty"` // VersionName: Resource name of the SecretVersion. In format: // projects/*/secrets/*/versions/* VersionName string `json:"versionName,omitempty"` // ForceSendFields is a list of field names (e.g. "Env") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Env") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SecretManagerSecret: Pairs a secret environment variable with a SecretVersion in Secret Manager.
func (*SecretManagerSecret) MarshalJSON ¶ added in v0.38.0
func (s *SecretManagerSecret) MarshalJSON() ([]byte, error)
type Secrets ¶ added in v0.38.0
type Secrets struct { // Inline: Secrets encrypted with KMS key and the associated secret // environment variable. Inline []*InlineSecret `json:"inline,omitempty"` // SecretManager: Secrets in Secret Manager and associated secret // environment variable. SecretManager []*SecretManagerSecret `json:"secretManager,omitempty"` // ForceSendFields is a list of field names (e.g. "Inline") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Inline") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Secrets: Secrets and secret environment variables.
func (*Secrets) MarshalJSON ¶ added in v0.38.0
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶
NewService creates a new Service.
type SlackDelivery ¶ added in v0.29.0
type SlackDelivery struct { // WebhookUri: The secret reference for the Slack webhook URI for // sending messages to a channel. WebhookUri *NotifierSecretRef `json:"webhookUri,omitempty"` // ForceSendFields is a list of field names (e.g. "WebhookUri") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "WebhookUri") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SlackDelivery: SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/webhooks.
func (*SlackDelivery) MarshalJSON ¶ added in v0.29.0
func (s *SlackDelivery) MarshalJSON() ([]byte, error)
type Source ¶
type Source struct { // RepoSource: If provided, get the source from this location in a Cloud // Source Repository. RepoSource *RepoSource `json:"repoSource,omitempty"` // StorageSource: If provided, get the source from this location in // Google Cloud Storage. StorageSource *StorageSource `json:"storageSource,omitempty"` // StorageSourceManifest: If provided, get the source from this manifest // in Google Cloud Storage. This feature is in Preview. StorageSourceManifest *StorageSourceManifest `json:"storageSourceManifest,omitempty"` // ForceSendFields is a list of field names (e.g. "RepoSource") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RepoSource") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Source: Location of the source in a supported storage service.
func (*Source) MarshalJSON ¶
type SourceProvenance ¶
type SourceProvenance struct { // FileHashes: Output only. Hash(es) of the build source, which can be // used to verify that the original source integrity was maintained in // the build. Note that `FileHashes` will only be populated if // `BuildOptions` has requested a `SourceProvenanceHash`. The keys to // this map are file paths used as build source and the values contain // the hash values for those files. If the build source came in a single // package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be // for the single path to that file. FileHashes map[string]FileHashes `json:"fileHashes,omitempty"` // ResolvedRepoSource: A copy of the build's `source.repo_source`, if // exists, with any revisions resolved. ResolvedRepoSource *RepoSource `json:"resolvedRepoSource,omitempty"` // ResolvedStorageSource: A copy of the build's `source.storage_source`, // if exists, with any generations resolved. ResolvedStorageSource *StorageSource `json:"resolvedStorageSource,omitempty"` // ResolvedStorageSourceManifest: A copy of the build's // `source.storage_source_manifest`, if exists, with any revisions // resolved. This feature is in Preview. ResolvedStorageSourceManifest *StorageSourceManifest `json:"resolvedStorageSourceManifest,omitempty"` // ForceSendFields is a list of field names (e.g. "FileHashes") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FileHashes") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SourceProvenance: Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
func (*SourceProvenance) MarshalJSON ¶
func (s *SourceProvenance) MarshalJSON() ([]byte, error)
type Status ¶ added in v0.26.0
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any user-facing error message should be localized and sent // in the google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
func (*Status) MarshalJSON ¶ added in v0.26.0
type StorageSource ¶
type StorageSource struct { // Bucket: Google Cloud Storage bucket containing the source (see Bucket // Name Requirements // (https://cloud.google.com/storage/docs/bucket-naming#requirements)). Bucket string `json:"bucket,omitempty"` // Generation: Google Cloud Storage generation for the object. If the // generation is omitted, the latest generation will be used. Generation int64 `json:"generation,omitempty,string"` // Object: Google Cloud Storage object containing the source. This // object must be a gzipped archive file (`.tar.gz`) containing source // to build. Object string `json:"object,omitempty"` // ForceSendFields is a list of field names (e.g. "Bucket") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Bucket") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
StorageSource: Location of the source in an archive file in Google Cloud Storage.
func (*StorageSource) MarshalJSON ¶
func (s *StorageSource) MarshalJSON() ([]byte, error)
type StorageSourceManifest ¶ added in v0.43.0
type StorageSourceManifest struct { // Bucket: Google Cloud Storage bucket containing the source manifest // (see Bucket Name Requirements // (https://cloud.google.com/storage/docs/bucket-naming#requirements)). Bucket string `json:"bucket,omitempty"` // Generation: Google Cloud Storage generation for the object. If the // generation is omitted, the latest generation will be used. Generation int64 `json:"generation,omitempty,string"` // Object: Google Cloud Storage object containing the source manifest. // This object must be a JSON file. Object string `json:"object,omitempty"` // ForceSendFields is a list of field names (e.g. "Bucket") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Bucket") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
StorageSourceManifest: Location of the source manifest in Google Cloud Storage. This feature is in Preview.
func (*StorageSourceManifest) MarshalJSON ¶ added in v0.43.0
func (s *StorageSourceManifest) MarshalJSON() ([]byte, error)
type TimeSpan ¶
type TimeSpan struct { // EndTime: End of time span. EndTime string `json:"endTime,omitempty"` // StartTime: Start of time span. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EndTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TimeSpan: Start and end times for a build execution phase.
func (*TimeSpan) MarshalJSON ¶
type Volume ¶
type Volume struct { // Name: Name of the volume to mount. Volume names must be unique per // build step and must be valid names for Docker volumes. Each named // volume must be used by at least two build steps. Name string `json:"name,omitempty"` // Path: Path at which to mount the volume. Paths must be absolute and // cannot conflict with other volume paths on the same build step or // with certain reserved volume paths. Path string `json:"path,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Volume: Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
func (*Volume) MarshalJSON ¶
type WorkerConfig ¶
type WorkerConfig struct { // DiskSizeGb: Size of the disk attached to the worker, in GB. See // https://cloud.google.com/compute/docs/disks/ If `0` is specified, // Cloud Build will use a standard disk size. DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"` // MachineType: Machine Type of the worker, such as n1-standard-1. See // https://cloud.google.com/compute/docs/machine-types. If left blank, // Cloud Build will use a standard unspecified machine to create the // worker pool. MachineType string `json:"machineType,omitempty"` // ForceSendFields is a list of field names (e.g. "DiskSizeGb") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DiskSizeGb") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
WorkerConfig: WorkerConfig defines the configuration to be used for a creating workers in the pool.
func (*WorkerConfig) MarshalJSON ¶
func (s *WorkerConfig) MarshalJSON() ([]byte, error)
type WorkerPool ¶
type WorkerPool struct { // CreateTime: Output only. Time at which the request to create the // `WorkerPool` was received. CreateTime string `json:"createTime,omitempty"` // DeleteTime: Output only. Time at which the request to delete the // `WorkerPool` was received. DeleteTime string `json:"deleteTime,omitempty"` // Name: Output only. The resource name of the `WorkerPool`. Format of // the name is `projects/{project_id}/workerPools/{worker_pool_id}`, // where the value of {worker_pool_id} is provided in the // CreateWorkerPool request. Name string `json:"name,omitempty"` // NetworkConfig: Network configuration for the `WorkerPool`. NetworkConfig *NetworkConfig `json:"networkConfig,omitempty"` // Region: Required. Immutable. The region where the `WorkerPool` runs. // Only "us-central1" is currently supported. Note that `region` cannot // be changed once the `WorkerPool` is created. Region string `json:"region,omitempty"` // State: Output only. WorkerPool state. // // Possible values: // "STATE_UNSPECIFIED" - State of the `WorkerPool` is unknown. // "CREATING" - `WorkerPool` is being created. // "RUNNING" - `WorkerPool` is running. // "DELETING" - `WorkerPool` is being deleted: cancelling builds and // draining workers. // "DELETED" - `WorkerPool` is deleted. State string `json:"state,omitempty"` // UpdateTime: Output only. Time at which the request to update the // `WorkerPool` was received. UpdateTime string `json:"updateTime,omitempty"` // WorkerConfig: Worker configuration for the `WorkerPool`. WorkerConfig *WorkerConfig `json:"workerConfig,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreateTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
WorkerPool: Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.
func (*WorkerPool) MarshalJSON ¶
func (s *WorkerPool) MarshalJSON() ([]byte, error)