Default request referring to version v1 of the Cloud Build API. This contains the host and root path used as a starting point for constructing service requests.

View and manage your data across Google Cloud Platform services

Represents the entirety of the methods and resources available for the Cloud Build API service.

A step in the build pipeline.

See: buildStep smart constructor.

Creates a value of BuildStep with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• bsStatus
• bsDir
• bsArgs
• bsEnv
• bsPullTiming
• bsEntrypoint
• bsWaitFor
• bsName
• bsId
• bsTiming
• bsSecretEnv
• bsTimeout
• bsVolumes

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.

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.

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.

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".

Output only. Stores timing information for pulling this build step's builder image only.

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

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.

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.

Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.

Output only. Stores timing information for executing this build step.

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`.

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.

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.

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

See: sourceProvenance smart constructor.

Creates a value of SourceProvenance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• spResolvedRepoSource
• spResolvedStorageSource
• spFileHashes

A copy of the build's `source.repo_source`, if exists, with any revisions resolved.

A copy of the build's `source.storage_source`, if exists, with any generations resolved.

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.

Response including listed builds.

See: listBuildsResponse smart constructor.

Creates a value of ListBuildsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lbrNextPageToken
• lbrBuilds

Token to receive the next page of results.

Builds will be sorted by `create_time`, descending.

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. 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.

See: status smart constructor.

Creates a value of Status with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sDetails
• sCode
• sMessage

A list of messages that carry the error details. There is a common set of message types for APIs to use.

The status code, which should be an enum value of google.rpc.Code.

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.

Specifies a build to retry.

See: retryBuildRequest smart constructor.

Creates a value of RetryBuildRequest with the minimum fields required to make a request.

The response message for Operations.ListOperations.

See: listOperationsResponse smart constructor.

Creates a value of ListOperationsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lorNextPageToken
• lorOperations

The standard List next-page token.

A list of operations that matches the specified filter in the request.

The request message for Operations.CancelOperation.

See: cancelOperationRequest smart constructor.

Creates a value of CancelOperationRequest with the minimum fields required to make a request.

Container message for hash values.

See: hash smart constructor.

Creates a value of Hash with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hValue
• hType

The hash value.

The type of hash that was performed.

Artifacts created by the build pipeline.

See: results smart constructor.

Creates a value of Results with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rImages
• rBuildStepImages
• rArtifactManifest
• rBuildStepOutputs
• rNumArtifacts

Container images that were built as a part of the build.

List of build step digests, in the order corresponding to build step indices.

Path to the artifact manifest. Only populated when artifacts are uploaded.

List of build step outputs, produced by builder images, in the order corresponding to build step indices. Cloud Builders can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored.

Number of artifacts uploaded. Only populated when artifacts are uploaded.

Substitutions data for Build resource.

See: buildTriggerSubstitutions smart constructor.

Creates a value of BuildTriggerSubstitutions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• btsAddtional

Location of the source in a Google Cloud Source Repository.

See: repoSource smart constructor.

Creates a value of RepoSource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rsRepoName
• rsDir
• rsCommitSha
• rsBranchName
• rsTagName
• rsProjectId

Name of the Cloud Source Repository. If omitted, the name "default" is assumed.

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.

Explicit commit SHA to build.

Name of the branch to build.

Name of the tag to build.

ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

This resource represents a long-running operation that is the result of a network API call.

See: operation smart constructor.

Creates a value of Operation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oDone
• oError
• oResponse
• oName
• oMetadata

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.

The error result of the operation in case of failure or cancellation.

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`.

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`.

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.

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 `{}`.

See: empty smart constructor.

Creates a value of Empty with the minimum fields required to make a request.

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.

See: secretSecretEnv smart constructor.

Creates a value of SecretSecretEnv with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sseAddtional

Artifacts produced by a build that should be uploaded upon successful completion of all build steps.

See: artifacts smart constructor.

Creates a value of Artifacts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aImages
• aObjects

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.

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.

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.