Documentation ¶
Overview ¶
Package cloudbuild provides access to the Cloud Container Builder.
See https://cloud.google.com/container-builder/docs/
Usage example:
import "google.golang.org/api/cloudbuild/v1" ... cloudbuildService, err := cloudbuild.New(oauthHttpClient)
Index ¶
- Constants
- type ArtifactObjects
- type ArtifactResult
- type Artifacts
- type Build
- type BuildOperationMetadata
- type BuildOptions
- type BuildStep
- type BuildTrigger
- type BuiltImage
- type CancelBuildRequest
- type CancelOperationRequest
- type Empty
- type FileHashes
- type Hash
- type ListBuildTriggersResponse
- type ListBuildsResponse
- type ListOperationsResponse
- type Operation
- type OperationsCancelCall
- type OperationsGetCall
- func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
- func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
- func (c *OperationsGetCall) Header() http.Header
- func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
- type OperationsListCall
- func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
- func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
- func (c *OperationsListCall) Filter(filter string) *OperationsListCall
- func (c *OperationsListCall) Header() http.Header
- func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
- func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
- func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
- func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type OperationsService
- type ProjectsBuildsCancelCall
- func (c *ProjectsBuildsCancelCall) Context(ctx context.Context) *ProjectsBuildsCancelCall
- func (c *ProjectsBuildsCancelCall) Do(opts ...googleapi.CallOption) (*Build, error)
- func (c *ProjectsBuildsCancelCall) Fields(s ...googleapi.Field) *ProjectsBuildsCancelCall
- func (c *ProjectsBuildsCancelCall) Header() http.Header
- type ProjectsBuildsCreateCall
- func (c *ProjectsBuildsCreateCall) Context(ctx context.Context) *ProjectsBuildsCreateCall
- func (c *ProjectsBuildsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsBuildsCreateCall) Fields(s ...googleapi.Field) *ProjectsBuildsCreateCall
- func (c *ProjectsBuildsCreateCall) Header() http.Header
- type ProjectsBuildsGetCall
- func (c *ProjectsBuildsGetCall) Context(ctx context.Context) *ProjectsBuildsGetCall
- func (c *ProjectsBuildsGetCall) Do(opts ...googleapi.CallOption) (*Build, error)
- func (c *ProjectsBuildsGetCall) Fields(s ...googleapi.Field) *ProjectsBuildsGetCall
- func (c *ProjectsBuildsGetCall) Header() http.Header
- func (c *ProjectsBuildsGetCall) IfNoneMatch(entityTag string) *ProjectsBuildsGetCall
- type ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) Context(ctx context.Context) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) Do(opts ...googleapi.CallOption) (*ListBuildsResponse, error)
- func (c *ProjectsBuildsListCall) Fields(s ...googleapi.Field) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) Filter(filter string) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) Header() http.Header
- func (c *ProjectsBuildsListCall) IfNoneMatch(entityTag string) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) PageSize(pageSize int64) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) PageToken(pageToken string) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) Pages(ctx context.Context, f func(*ListBuildsResponse) error) error
- type ProjectsBuildsRetryCall
- func (c *ProjectsBuildsRetryCall) Context(ctx context.Context) *ProjectsBuildsRetryCall
- func (c *ProjectsBuildsRetryCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsBuildsRetryCall) Fields(s ...googleapi.Field) *ProjectsBuildsRetryCall
- func (c *ProjectsBuildsRetryCall) Header() http.Header
- type ProjectsBuildsService
- func (r *ProjectsBuildsService) Cancel(projectId string, id string, cancelbuildrequest *CancelBuildRequest) *ProjectsBuildsCancelCall
- func (r *ProjectsBuildsService) Create(projectId string, build *Build) *ProjectsBuildsCreateCall
- func (r *ProjectsBuildsService) Get(projectId string, id string) *ProjectsBuildsGetCall
- func (r *ProjectsBuildsService) List(projectId string) *ProjectsBuildsListCall
- func (r *ProjectsBuildsService) Retry(projectId string, id string, retrybuildrequest *RetryBuildRequest) *ProjectsBuildsRetryCall
- type ProjectsService
- type ProjectsTriggersCreateCall
- func (c *ProjectsTriggersCreateCall) Context(ctx context.Context) *ProjectsTriggersCreateCall
- func (c *ProjectsTriggersCreateCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
- func (c *ProjectsTriggersCreateCall) Fields(s ...googleapi.Field) *ProjectsTriggersCreateCall
- func (c *ProjectsTriggersCreateCall) Header() http.Header
- type ProjectsTriggersDeleteCall
- func (c *ProjectsTriggersDeleteCall) Context(ctx context.Context) *ProjectsTriggersDeleteCall
- func (c *ProjectsTriggersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsTriggersDeleteCall) Fields(s ...googleapi.Field) *ProjectsTriggersDeleteCall
- func (c *ProjectsTriggersDeleteCall) Header() http.Header
- type ProjectsTriggersGetCall
- func (c *ProjectsTriggersGetCall) Context(ctx context.Context) *ProjectsTriggersGetCall
- func (c *ProjectsTriggersGetCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
- func (c *ProjectsTriggersGetCall) Fields(s ...googleapi.Field) *ProjectsTriggersGetCall
- func (c *ProjectsTriggersGetCall) Header() http.Header
- func (c *ProjectsTriggersGetCall) IfNoneMatch(entityTag string) *ProjectsTriggersGetCall
- type ProjectsTriggersListCall
- func (c *ProjectsTriggersListCall) Context(ctx context.Context) *ProjectsTriggersListCall
- func (c *ProjectsTriggersListCall) Do(opts ...googleapi.CallOption) (*ListBuildTriggersResponse, error)
- func (c *ProjectsTriggersListCall) Fields(s ...googleapi.Field) *ProjectsTriggersListCall
- func (c *ProjectsTriggersListCall) Header() http.Header
- func (c *ProjectsTriggersListCall) IfNoneMatch(entityTag string) *ProjectsTriggersListCall
- type ProjectsTriggersPatchCall
- func (c *ProjectsTriggersPatchCall) Context(ctx context.Context) *ProjectsTriggersPatchCall
- func (c *ProjectsTriggersPatchCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
- func (c *ProjectsTriggersPatchCall) Fields(s ...googleapi.Field) *ProjectsTriggersPatchCall
- func (c *ProjectsTriggersPatchCall) Header() http.Header
- type ProjectsTriggersRunCall
- func (c *ProjectsTriggersRunCall) Context(ctx context.Context) *ProjectsTriggersRunCall
- func (c *ProjectsTriggersRunCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsTriggersRunCall) Fields(s ...googleapi.Field) *ProjectsTriggersRunCall
- func (c *ProjectsTriggersRunCall) Header() http.Header
- type ProjectsTriggersService
- func (r *ProjectsTriggersService) Create(projectId string, buildtrigger *BuildTrigger) *ProjectsTriggersCreateCall
- func (r *ProjectsTriggersService) Delete(projectId string, triggerId string) *ProjectsTriggersDeleteCall
- func (r *ProjectsTriggersService) Get(projectId string, triggerId string) *ProjectsTriggersGetCall
- func (r *ProjectsTriggersService) List(projectId string) *ProjectsTriggersListCall
- func (r *ProjectsTriggersService) Patch(projectId string, triggerId string, buildtrigger *BuildTrigger) *ProjectsTriggersPatchCall
- func (r *ProjectsTriggersService) Run(projectId string, triggerId string, reposource *RepoSource) *ProjectsTriggersRunCall
- type RepoSource
- type Results
- type RetryBuildRequest
- type Secret
- type Service
- type Source
- type SourceProvenance
- type Status
- type StorageSource
- type TimeSpan
- type Volume
Constants ¶
const (
// View and manage your data across Google Cloud Platform services
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"` // 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"` // Options: Special options for this build. Options *BuildOptions `json:"options,omitempty"` // ProjectId: Output only. ID of the project. ProjectId string `json:"projectId,omitempty"` // Results: Output only. Results of the build. Results *Results `json:"results,omitempty"` // Secrets: Secrets to decrypt using Cloud Key Management Service. Secrets []*Secret `json:"secrets,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. 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`. // // 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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // 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 Container Builder 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. - $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"` // 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"` // 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. 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"` // 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. // // 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"` // 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"` // 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. 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 will be created as an empty volume prior to execution of // the // build step. Upon completion of the build, volumes and their contents // will // be discarded. // // Using a named volume in only one step is not valid as it is // indicative // of a mis-configured build request. 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 BuildTrigger ¶
type BuildTrigger struct { // Build: Contents of the build template. Build *Build `json:"build,omitempty"` // CreateTime: Output only. Time when the trigger was created. CreateTime string `json:"createTime,omitempty"` // Description: Human-readable description of this trigger. Description string `json:"description,omitempty"` // Disabled: If true, the trigger will never result in a build. Disabled bool `json:"disabled,omitempty"` // Filename: Path, from the source root, to a file whose contents is // used for the // template. Filename string `json:"filename,omitempty"` // Id: Output only. Unique identifier of the trigger. Id string `json:"id,omitempty"` // Substitutions: Substitutions data for Build resource. Substitutions map[string]string `json:"substitutions,omitempty"` // TriggerTemplate: Template describing the types of source changes to // trigger a build. // // Branch and tag names in trigger templates are interpreted as // regular // expressions. Any branch or tag change that matches that regular // expression // will trigger a build. TriggerTemplate *RepoSource `json:"triggerTemplate,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // 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:"-"` }
BuildTrigger: Configuration for an automated build in response to source repository changes.
func (*BuildTrigger) MarshalJSON ¶
func (s *BuildTrigger) MarshalJSON() ([]byte, error)
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 CancelBuildRequest ¶
type CancelBuildRequest struct { }
CancelBuildRequest: Request to cancel an ongoing build.
type CancelOperationRequest ¶
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 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 ListBuildTriggersResponse ¶
type ListBuildTriggersResponse struct { // Triggers: `BuildTriggers` for the project, sorted by `create_time` // descending. Triggers []*BuildTrigger `json:"triggers,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Triggers") 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. "Triggers") 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:"-"` }
ListBuildTriggersResponse: Response containing existing `BuildTriggers`.
func (*ListBuildTriggersResponse) MarshalJSON ¶
func (s *ListBuildTriggersResponse) MarshalJSON() ([]byte, error)
type ListBuildsResponse ¶
type ListBuildsResponse struct { // Builds: Builds will be sorted by `create_time`, descending. Builds []*Build `json:"builds,omitempty"` // NextPageToken: Token to receive the next page of results. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Builds") 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. "Builds") 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:"-"` }
ListBuildsResponse: Response including listed builds.
func (*ListBuildsResponse) MarshalJSON ¶
func (s *ListBuildsResponse) MarshalJSON() ([]byte, error)
type ListOperationsResponse ¶
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*Operation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") 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. "NextPageToken") 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:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (*ListOperationsResponse) MarshalJSON ¶
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type Operation ¶
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 have the format of `operations/some/unique/name`. 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 ¶
type OperationsCancelCall ¶
type OperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*OperationsCancelCall) Context ¶
func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall
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 (*OperationsCancelCall) Do ¶
func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudbuild.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 (*OperationsCancelCall) Fields ¶
func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsCancelCall) Header ¶
func (c *OperationsCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OperationsGetCall ¶
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (*OperationsGetCall) Context ¶
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
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 (*OperationsGetCall) Do ¶
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudbuild.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 (*OperationsGetCall) Fields ¶
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsGetCall) Header ¶
func (c *OperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*OperationsGetCall) IfNoneMatch ¶
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
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 OperationsListCall ¶
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (*OperationsListCall) Context ¶
func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
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 (*OperationsListCall) Do ¶
func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "cloudbuild.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.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 (*OperationsListCall) Fields ¶
func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsListCall) Filter ¶
func (c *OperationsListCall) Filter(filter string) *OperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*OperationsListCall) Header ¶
func (c *OperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*OperationsListCall) IfNoneMatch ¶
func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
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.
func (*OperationsListCall) PageSize ¶
func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*OperationsListCall) PageToken ¶
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*OperationsListCall) Pages ¶
func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type OperationsService ¶
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶
func NewOperationsService(s *Service) *OperationsService
func (*OperationsService) Cancel ¶
func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall
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 (*OperationsService) Get ¶
func (r *OperationsService) Get(name string) *OperationsGetCall
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.
func (*OperationsService) List ¶
func (r *OperationsService) List(name string) *OperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
type ProjectsBuildsCancelCall ¶
type ProjectsBuildsCancelCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsCancelCall) Context ¶
func (c *ProjectsBuildsCancelCall) Context(ctx context.Context) *ProjectsBuildsCancelCall
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 (*ProjectsBuildsCancelCall) Do ¶
func (c *ProjectsBuildsCancelCall) Do(opts ...googleapi.CallOption) (*Build, error)
Do executes the "cloudbuild.projects.builds.cancel" call. Exactly one of *Build or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Build.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 (*ProjectsBuildsCancelCall) Fields ¶
func (c *ProjectsBuildsCancelCall) Fields(s ...googleapi.Field) *ProjectsBuildsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBuildsCancelCall) Header ¶
func (c *ProjectsBuildsCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsBuildsCreateCall ¶
type ProjectsBuildsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsCreateCall) Context ¶
func (c *ProjectsBuildsCreateCall) Context(ctx context.Context) *ProjectsBuildsCreateCall
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 (*ProjectsBuildsCreateCall) Do ¶
func (c *ProjectsBuildsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudbuild.projects.builds.create" 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 (*ProjectsBuildsCreateCall) Fields ¶
func (c *ProjectsBuildsCreateCall) Fields(s ...googleapi.Field) *ProjectsBuildsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBuildsCreateCall) Header ¶
func (c *ProjectsBuildsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsBuildsGetCall ¶
type ProjectsBuildsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsGetCall) Context ¶
func (c *ProjectsBuildsGetCall) Context(ctx context.Context) *ProjectsBuildsGetCall
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 (*ProjectsBuildsGetCall) Do ¶
func (c *ProjectsBuildsGetCall) Do(opts ...googleapi.CallOption) (*Build, error)
Do executes the "cloudbuild.projects.builds.get" call. Exactly one of *Build or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Build.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 (*ProjectsBuildsGetCall) Fields ¶
func (c *ProjectsBuildsGetCall) Fields(s ...googleapi.Field) *ProjectsBuildsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBuildsGetCall) Header ¶
func (c *ProjectsBuildsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsBuildsGetCall) IfNoneMatch ¶
func (c *ProjectsBuildsGetCall) IfNoneMatch(entityTag string) *ProjectsBuildsGetCall
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 ProjectsBuildsListCall ¶
type ProjectsBuildsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsListCall) Context ¶
func (c *ProjectsBuildsListCall) Context(ctx context.Context) *ProjectsBuildsListCall
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 (*ProjectsBuildsListCall) Do ¶
func (c *ProjectsBuildsListCall) Do(opts ...googleapi.CallOption) (*ListBuildsResponse, error)
Do executes the "cloudbuild.projects.builds.list" call. Exactly one of *ListBuildsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBuildsResponse.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 (*ProjectsBuildsListCall) Fields ¶
func (c *ProjectsBuildsListCall) Fields(s ...googleapi.Field) *ProjectsBuildsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBuildsListCall) Filter ¶
func (c *ProjectsBuildsListCall) Filter(filter string) *ProjectsBuildsListCall
Filter sets the optional parameter "filter": The raw filter text to constrain the results.
func (*ProjectsBuildsListCall) Header ¶
func (c *ProjectsBuildsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsBuildsListCall) IfNoneMatch ¶
func (c *ProjectsBuildsListCall) IfNoneMatch(entityTag string) *ProjectsBuildsListCall
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.
func (*ProjectsBuildsListCall) PageSize ¶
func (c *ProjectsBuildsListCall) PageSize(pageSize int64) *ProjectsBuildsListCall
PageSize sets the optional parameter "pageSize": Number of results to return in the list.
func (*ProjectsBuildsListCall) PageToken ¶
func (c *ProjectsBuildsListCall) PageToken(pageToken string) *ProjectsBuildsListCall
PageToken sets the optional parameter "pageToken": Token to provide to skip to a particular spot in the list.
func (*ProjectsBuildsListCall) Pages ¶
func (c *ProjectsBuildsListCall) Pages(ctx context.Context, f func(*ListBuildsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsBuildsRetryCall ¶
type ProjectsBuildsRetryCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsRetryCall) Context ¶
func (c *ProjectsBuildsRetryCall) Context(ctx context.Context) *ProjectsBuildsRetryCall
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 (*ProjectsBuildsRetryCall) Do ¶
func (c *ProjectsBuildsRetryCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudbuild.projects.builds.retry" 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 (*ProjectsBuildsRetryCall) Fields ¶
func (c *ProjectsBuildsRetryCall) Fields(s ...googleapi.Field) *ProjectsBuildsRetryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBuildsRetryCall) Header ¶
func (c *ProjectsBuildsRetryCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsBuildsService ¶
type ProjectsBuildsService struct {
// contains filtered or unexported fields
}
func NewProjectsBuildsService ¶
func NewProjectsBuildsService(s *Service) *ProjectsBuildsService
func (*ProjectsBuildsService) Cancel ¶
func (r *ProjectsBuildsService) Cancel(projectId string, id string, cancelbuildrequest *CancelBuildRequest) *ProjectsBuildsCancelCall
Cancel: Cancels a build in progress.
func (*ProjectsBuildsService) Create ¶
func (r *ProjectsBuildsService) Create(projectId string, build *Build) *ProjectsBuildsCreateCall
Create: Starts a build with the specified configuration.
This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).
func (*ProjectsBuildsService) Get ¶
func (r *ProjectsBuildsService) Get(projectId string, id string) *ProjectsBuildsGetCall
Get: Returns information about a previously requested build.
The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.
func (*ProjectsBuildsService) List ¶
func (r *ProjectsBuildsService) List(projectId string) *ProjectsBuildsListCall
List: Lists previously requested builds.
Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
func (*ProjectsBuildsService) Retry ¶
func (r *ProjectsBuildsService) Retry(projectId string, id string, retrybuildrequest *RetryBuildRequest) *ProjectsBuildsRetryCall
Retry: Creates a new build based on the specified build.
This method creates a new build using the original build request, which may or may not result in an identical build.
For triggered builds:
* Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.
For non-triggered builds that specify `RepoSource`:
* If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source.
For builds that specify `StorageSource`:
* If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
type ProjectsService ¶
type ProjectsService struct { Builds *ProjectsBuildsService Triggers *ProjectsTriggersService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type ProjectsTriggersCreateCall ¶
type ProjectsTriggersCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersCreateCall) Context ¶
func (c *ProjectsTriggersCreateCall) Context(ctx context.Context) *ProjectsTriggersCreateCall
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 (*ProjectsTriggersCreateCall) Do ¶
func (c *ProjectsTriggersCreateCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
Do executes the "cloudbuild.projects.triggers.create" call. Exactly one of *BuildTrigger or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BuildTrigger.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 (*ProjectsTriggersCreateCall) Fields ¶
func (c *ProjectsTriggersCreateCall) Fields(s ...googleapi.Field) *ProjectsTriggersCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTriggersCreateCall) Header ¶
func (c *ProjectsTriggersCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTriggersDeleteCall ¶
type ProjectsTriggersDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersDeleteCall) Context ¶
func (c *ProjectsTriggersDeleteCall) Context(ctx context.Context) *ProjectsTriggersDeleteCall
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 (*ProjectsTriggersDeleteCall) Do ¶
func (c *ProjectsTriggersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudbuild.projects.triggers.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 (*ProjectsTriggersDeleteCall) Fields ¶
func (c *ProjectsTriggersDeleteCall) Fields(s ...googleapi.Field) *ProjectsTriggersDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTriggersDeleteCall) Header ¶
func (c *ProjectsTriggersDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTriggersGetCall ¶
type ProjectsTriggersGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersGetCall) Context ¶
func (c *ProjectsTriggersGetCall) Context(ctx context.Context) *ProjectsTriggersGetCall
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 (*ProjectsTriggersGetCall) Do ¶
func (c *ProjectsTriggersGetCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
Do executes the "cloudbuild.projects.triggers.get" call. Exactly one of *BuildTrigger or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BuildTrigger.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 (*ProjectsTriggersGetCall) Fields ¶
func (c *ProjectsTriggersGetCall) Fields(s ...googleapi.Field) *ProjectsTriggersGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTriggersGetCall) Header ¶
func (c *ProjectsTriggersGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsTriggersGetCall) IfNoneMatch ¶
func (c *ProjectsTriggersGetCall) IfNoneMatch(entityTag string) *ProjectsTriggersGetCall
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 ProjectsTriggersListCall ¶
type ProjectsTriggersListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersListCall) Context ¶
func (c *ProjectsTriggersListCall) Context(ctx context.Context) *ProjectsTriggersListCall
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 (*ProjectsTriggersListCall) Do ¶
func (c *ProjectsTriggersListCall) Do(opts ...googleapi.CallOption) (*ListBuildTriggersResponse, error)
Do executes the "cloudbuild.projects.triggers.list" call. Exactly one of *ListBuildTriggersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBuildTriggersResponse.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 (*ProjectsTriggersListCall) Fields ¶
func (c *ProjectsTriggersListCall) Fields(s ...googleapi.Field) *ProjectsTriggersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTriggersListCall) Header ¶
func (c *ProjectsTriggersListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsTriggersListCall) IfNoneMatch ¶
func (c *ProjectsTriggersListCall) IfNoneMatch(entityTag string) *ProjectsTriggersListCall
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 ProjectsTriggersPatchCall ¶
type ProjectsTriggersPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersPatchCall) Context ¶
func (c *ProjectsTriggersPatchCall) Context(ctx context.Context) *ProjectsTriggersPatchCall
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 (*ProjectsTriggersPatchCall) Do ¶
func (c *ProjectsTriggersPatchCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
Do executes the "cloudbuild.projects.triggers.patch" call. Exactly one of *BuildTrigger or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BuildTrigger.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 (*ProjectsTriggersPatchCall) Fields ¶
func (c *ProjectsTriggersPatchCall) Fields(s ...googleapi.Field) *ProjectsTriggersPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTriggersPatchCall) Header ¶
func (c *ProjectsTriggersPatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTriggersRunCall ¶
type ProjectsTriggersRunCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersRunCall) Context ¶
func (c *ProjectsTriggersRunCall) Context(ctx context.Context) *ProjectsTriggersRunCall
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 (*ProjectsTriggersRunCall) Do ¶
func (c *ProjectsTriggersRunCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudbuild.projects.triggers.run" 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 (*ProjectsTriggersRunCall) Fields ¶
func (c *ProjectsTriggersRunCall) Fields(s ...googleapi.Field) *ProjectsTriggersRunCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTriggersRunCall) Header ¶
func (c *ProjectsTriggersRunCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTriggersService ¶
type ProjectsTriggersService struct {
// contains filtered or unexported fields
}
func NewProjectsTriggersService ¶
func NewProjectsTriggersService(s *Service) *ProjectsTriggersService
func (*ProjectsTriggersService) Create ¶
func (r *ProjectsTriggersService) Create(projectId string, buildtrigger *BuildTrigger) *ProjectsTriggersCreateCall
Create: Creates a new `BuildTrigger`.
This API is experimental.
func (*ProjectsTriggersService) Delete ¶
func (r *ProjectsTriggersService) Delete(projectId string, triggerId string) *ProjectsTriggersDeleteCall
Delete: Deletes a `BuildTrigger` by its project ID and trigger ID.
This API is experimental.
func (*ProjectsTriggersService) Get ¶
func (r *ProjectsTriggersService) Get(projectId string, triggerId string) *ProjectsTriggersGetCall
Get: Returns information about a `BuildTrigger`.
This API is experimental.
func (*ProjectsTriggersService) List ¶
func (r *ProjectsTriggersService) List(projectId string) *ProjectsTriggersListCall
List: Lists existing `BuildTrigger`s.
This API is experimental.
func (*ProjectsTriggersService) Patch ¶
func (r *ProjectsTriggersService) Patch(projectId string, triggerId string, buildtrigger *BuildTrigger) *ProjectsTriggersPatchCall
Patch: Updates a `BuildTrigger` by its project ID and trigger ID.
This API is experimental.
func (*ProjectsTriggersService) Run ¶
func (r *ProjectsTriggersService) Run(projectId string, triggerId string, reposource *RepoSource) *ProjectsTriggersRunCall
Run: Runs a `BuildTrigger` at a particular source revision.
type RepoSource ¶
type RepoSource struct { // BranchName: Name of the branch to build. 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"` // 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. If omitted, the name // "default" is // assumed. RepoName string `json:"repoName,omitempty"` // TagName: Name of the tag to build. 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"` // BuildStepImages: List of build step digests, in the order // corresponding to build step // indices. BuildStepImages []string `json:"buildStepImages,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 RetryBuildRequest ¶
type RetryBuildRequest struct { }
RetryBuildRequest: Specifies a build to retry.
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 // 1 KB in size. There can be at most ten 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.
func (*Secret) MarshalJSON ¶
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Operations *OperationsService Projects *ProjectsService // contains filtered or unexported fields }
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"` // 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 originalsource integrity was maintained in the build. Note // that // `FileHashes` willonly 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"` // 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 ¶
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). The error model is designed to be:
- Simple to use and understand for most users - Flexible enough to meet unexpected needs
Overview ¶
The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions.
Language mapping ¶
The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.
Other uses ¶
The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the
partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting.
- Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response,
one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should
be
represented directly using the `Status` message.
- Logging. If some API errors are stored in logs, the message `Status` could
be used directly after any stripping needed for security/privacy
reasons.
func (*Status) MarshalJSON ¶
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 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.