Package-level declarations

Types

Link copied to clipboard
data class ApprovalConfigResponse(val approvalRequired: Boolean)

ApprovalConfig describes configuration for manual approval of a build.

Link copied to clipboard
data class ApprovalResultResponse(val approvalTime: String, val approverAccount: String, val comment: String, val decision: String, val url: String)

ApprovalResult describes the decision and associated metadata of a manual approval of a build.

Link copied to clipboard
data class ArtifactObjectsResponse(val location: String, val paths: List<String>, val timing: TimeSpanResponse)

Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.

Link copied to clipboard
data class ArtifactsResponse(val images: List<String>, val mavenArtifacts: List<MavenArtifactResponse>, val npmPackages: List<NpmPackageResponse>, val objects: ArtifactObjectsResponse, val pythonPackages: List<PythonPackageResponse>)

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

Link copied to clipboard
data class BitbucketServerConfigResponse(val apiKey: String, val connectedRepositories: List<BitbucketServerRepositoryIdResponse>, val createTime: String, val hostUri: String, val name: String, val peeredNetwork: String, val secrets: BitbucketServerSecretsResponse, val sslCa: String, val username: String, val webhookKey: String)

BitbucketServerConfig represents the configuration for a Bitbucket Server.

Link copied to clipboard
data class BitbucketServerRepositoryIdResponse(val projectKey: String, val repoSlug: String, val webhookId: Int)

BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.

Link copied to clipboard
data class BitbucketServerSecretsResponse(val adminAccessTokenVersionName: String, val readAccessTokenVersionName: String, val webhookSecretVersionName: String)

BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server.

Link copied to clipboard
data class BitbucketServerTriggerConfigResponse(val bitbucketServerConfig: BitbucketServerConfigResponse, val bitbucketServerConfigResource: String, val projectKey: String, val pullRequest: PullRequestFilterResponse, val push: PushFilterResponse, val repoSlug: String)

BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received.

Link copied to clipboard
data class BuildApprovalResponse(val config: ApprovalConfigResponse, val result: ApprovalResultResponse, val state: String)

BuildApproval describes a build's approval configuration, state, and result.

Link copied to clipboard
data class BuildOptionsResponse(val defaultLogsBucketBehavior: String, val diskSizeGb: String, val dynamicSubstitutions: Boolean, val env: List<String>, val logStreamingOption: String, val logging: String, val machineType: String, val pool: PoolOptionResponse, val requestedVerifyOption: String, val secretEnv: List<String>, val sourceProvenanceHash: List<String>, val substitutionOption: String, val volumes: List<VolumeResponse>, val workerPool: String)

Optional arguments to enable specific features of builds.

Link copied to clipboard
data class BuildResponse(val approval: BuildApprovalResponse, val artifacts: ArtifactsResponse, val availableSecrets: SecretsResponse, val buildTriggerId: String, val createTime: String, val failureInfo: FailureInfoResponse, val finishTime: String, val images: List<String>, val logUrl: String, val logsBucket: String, val name: String, val options: BuildOptionsResponse, val project: String, val queueTtl: String, val results: ResultsResponse, val secrets: List<SecretResponse>, val serviceAccount: String, val source: SourceResponse, val sourceProvenance: SourceProvenanceResponse, val startTime: String, val status: String, val statusDetail: String, val steps: List<BuildStepResponse>, val substitutions: Map<String, String>, val tags: List<String>, val timeout: String, val timing: Map<String, String>, val warnings: List<WarningResponse>)

A build resource in the Cloud Build API. At a high level, a Build describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region 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.

Link copied to clipboard
data class BuildStepResponse(val allowExitCodes: List<Int>, val allowFailure: Boolean, val args: List<String>, val dir: String, val entrypoint: String, val env: List<String>, val exitCode: Int, val name: String, val pullTiming: TimeSpanResponse, val script: String, val secretEnv: List<String>, val status: String, val timeout: String, val timing: TimeSpanResponse, val volumes: List<VolumeResponse>, val waitFor: List<String>)

A step in the build pipeline.

Link copied to clipboard
data class BuiltImageResponse(val digest: String, val name: String, val pushTiming: TimeSpanResponse)

An image built by the pipeline.

Link copied to clipboard
data class FailureInfoResponse(val detail: String, val type: String)

A fatal problem encountered during the execution of the build.

Link copied to clipboard
data class FileHashesResponse(val fileHash: List<HashResponse>)

Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.

Link copied to clipboard
data class GetBitbucketServerConfigResult(val apiKey: String, val connectedRepositories: List<BitbucketServerRepositoryIdResponse>, val createTime: String, val hostUri: String, val name: String, val peeredNetwork: String, val secrets: BitbucketServerSecretsResponse, val sslCa: String, val username: String, val webhookKey: String)
Link copied to clipboard
data class GetBuildResult(val approval: BuildApprovalResponse, val artifacts: ArtifactsResponse, val availableSecrets: SecretsResponse, val buildTriggerId: String, val createTime: String, val failureInfo: FailureInfoResponse, val finishTime: String, val images: List<String>, val logUrl: String, val logsBucket: String, val name: String, val options: BuildOptionsResponse, val project: String, val queueTtl: String, val results: ResultsResponse, val secrets: List<SecretResponse>, val serviceAccount: String, val source: SourceResponse, val sourceProvenance: SourceProvenanceResponse, val startTime: String, val status: String, val statusDetail: String, val steps: List<BuildStepResponse>, val substitutions: Map<String, String>, val tags: List<String>, val timeout: String, val timing: Map<String, String>, val warnings: List<WarningResponse>)
Link copied to clipboard
data class GetGithubEnterpriseConfigResult(val appId: String, val createTime: String, val displayName: String, val hostUrl: String, val name: String, val peeredNetwork: String, val secrets: GitHubEnterpriseSecretsResponse, val sslCa: String, val webhookKey: String)
Link copied to clipboard
data class GetGitLabConfigResult(val connectedRepositories: List<GitLabRepositoryIdResponse>, val createTime: String, val enterpriseConfig: GitLabEnterpriseConfigResponse, val name: String, val secrets: GitLabSecretsResponse, val username: String, val webhookKey: String)
Link copied to clipboard
data class GetTriggerResult(val approvalConfig: ApprovalConfigResponse, val autodetect: Boolean, val bitbucketServerTriggerConfig: BitbucketServerTriggerConfigResponse, val build: BuildResponse, val createTime: String, val description: String, val disabled: Boolean, val eventType: String, val filename: String, val filter: String, val gitFileSource: GitFileSourceResponse, val github: GitHubEventsConfigResponse, val gitlabEnterpriseEventsConfig: GitLabEventsConfigResponse, val ignoredFiles: List<String>, val includeBuildLogs: String, val includedFiles: List<String>, val name: String, val pubsubConfig: PubsubConfigResponse, val repositoryEventConfig: RepositoryEventConfigResponse, val resourceName: String, val serviceAccount: String, val sourceToBuild: GitRepoSourceResponse, val substitutions: Map<String, String>, val tags: List<String>, val triggerTemplate: RepoSourceResponse, val webhookConfig: WebhookConfigResponse)
Link copied to clipboard
data class GetWorkerPoolResult(val annotations: Map<String, String>, val createTime: String, val deleteTime: String, val displayName: String, val etag: String, val name: String, val privatePoolV1Config: PrivatePoolV1ConfigResponse, val state: String, val uid: String, val updateTime: String)
Link copied to clipboard
data class GitFileSourceResponse(val bitbucketServerConfig: String, val githubEnterpriseConfig: String, val path: String, val repoType: String, val repository: String, val revision: String, val uri: String)

GitFileSource describes a file within a (possibly remote) code repository.

Link copied to clipboard
data class GitHubEnterpriseSecretsResponse(val oauthClientIdName: String, val oauthClientIdVersionName: String, val oauthSecretName: String, val oauthSecretVersionName: String, val privateKeyName: String, val privateKeyVersionName: String, val webhookSecretName: String, val webhookSecretVersionName: String)

GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/.

Link copied to clipboard
data class GitHubEventsConfigResponse(val enterpriseConfigResourceName: String, val installationId: String, val name: String, val owner: String, val pullRequest: PullRequestFilterResponse, val push: PushFilterResponse)

GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.

Link copied to clipboard
data class GitLabConfigResponse(val connectedRepositories: List<GitLabRepositoryIdResponse>, val createTime: String, val enterpriseConfig: GitLabEnterpriseConfigResponse, val name: String, val secrets: GitLabSecretsResponse, val username: String, val webhookKey: String)

GitLabConfig represents the configuration for a GitLab integration.

Link copied to clipboard
data class GitLabEnterpriseConfigResponse(val hostUri: String, val serviceDirectoryConfig: ServiceDirectoryConfigResponse, val sslCa: String)

GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration.

Link copied to clipboard
data class GitLabEventsConfigResponse(val gitlabConfig: GitLabConfigResponse, val gitlabConfigResource: String, val projectNamespace: String, val pullRequest: PullRequestFilterResponse, val push: PushFilterResponse)

GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received.

Link copied to clipboard
data class GitLabRepositoryIdResponse(val webhookId: Int)

GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise

Link copied to clipboard
data class GitLabSecretsResponse(val apiAccessTokenVersion: String, val apiKeyVersion: String, val readAccessTokenVersion: String, val webhookSecretVersion: String)

GitLabSecrets represents the secrets in Secret Manager for a GitLab integration.

Link copied to clipboard
data class GitRepoSourceResponse(val bitbucketServerConfig: String, val githubEnterpriseConfig: String, val ref: String, val repoType: String, val repository: String, val uri: String)

GitRepoSource describes a repo and ref of a code repository.

Link copied to clipboard
data class GitSourceResponse(val dir: String, val revision: String, val url: String)

Location of the source in any accessible Git repository.

Link copied to clipboard
data class HashResponse(val type: String, val value: String)

Container message for hash values.

Link copied to clipboard
data class InlineSecretResponse(val envMap: Map<String, String>, val kmsKeyName: String)

Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.

Link copied to clipboard
data class MavenArtifactResponse(val artifactId: String, val groupId: String, val path: String, val repository: String, val version: String)

A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.

Link copied to clipboard
data class NetworkConfigResponse(val egressOption: String, val peeredNetwork: String, val peeredNetworkIpRange: String)

Defines the network configuration for the pool.

Link copied to clipboard
data class NpmPackageResponse(val packagePath: String, val repository: String)

Npm package to upload to Artifact Registry upon successful completion of all build steps.

Link copied to clipboard
data class PoolOptionResponse(val name: String)

Details about how a build should be executed on a WorkerPool. See running builds in a private pool for more information.

Link copied to clipboard
data class PrivatePoolV1ConfigResponse(val networkConfig: NetworkConfigResponse, val workerConfig: WorkerConfigResponse)

Configuration for a V1 PrivatePool.

Link copied to clipboard
data class PubsubConfigResponse(val serviceAccountEmail: String, val state: String, val subscription: String, val topic: String)

PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.

Link copied to clipboard
data class PullRequestFilterResponse(val branch: String, val commentControl: String, val invertRegex: Boolean)

PullRequestFilter contains filter properties for matching GitHub Pull Requests.

Link copied to clipboard
data class PushFilterResponse(val branch: String, val invertRegex: Boolean, val tag: String)

Push contains filter properties for matching GitHub git pushes.

Link copied to clipboard
data class PythonPackageResponse(val paths: List<String>, val repository: String)

Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.

Link copied to clipboard
data class RepositoryEventConfigResponse(val pullRequest: PullRequestFilterResponse, val push: PushFilterResponse, val repository: String, val repositoryType: String)

The configuration of a trigger that creates a build whenever an event from Repo API is received.

Link copied to clipboard
data class RepoSourceResponse(val branchName: String, val commitSha: String, val dir: String, val invertRegex: Boolean, val project: String, val repoName: String, val substitutions: Map<String, String>, val tagName: String)

Location of the source in a Google Cloud Source Repository.

Link copied to clipboard
data class ResultsResponse(val artifactManifest: String, val artifactTiming: TimeSpanResponse, val buildStepImages: List<String>, val buildStepOutputs: List<String>, val images: List<BuiltImageResponse>, val mavenArtifacts: List<UploadedMavenArtifactResponse>, val npmPackages: List<UploadedNpmPackageResponse>, val numArtifacts: String, val pythonPackages: List<UploadedPythonPackageResponse>)

Artifacts created by the build pipeline.

Link copied to clipboard
data class SecretManagerSecretResponse(val env: String, val versionName: String)

Pairs a secret environment variable with a SecretVersion in Secret Manager.

Link copied to clipboard
data class SecretResponse(val kmsKeyName: String, val secretEnv: Map<String, String>)

Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use kmsKeyName with available_secrets instead of using kmsKeyName with secret. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.

Link copied to clipboard
data class SecretsResponse(val inline: List<InlineSecretResponse>, val secretManager: List<SecretManagerSecretResponse>)

Secrets and secret environment variables.

Link copied to clipboard
data class ServiceDirectoryConfigResponse(val service: String)

ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection.

Link copied to clipboard
data class SourceProvenanceResponse(val fileHashes: Map<String, String>, val resolvedRepoSource: RepoSourceResponse, val resolvedStorageSource: StorageSourceResponse, val resolvedStorageSourceManifest: StorageSourceManifestResponse)

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

Link copied to clipboard
data class SourceResponse(val gitSource: GitSourceResponse, val repoSource: RepoSourceResponse, val storageSource: StorageSourceResponse, val storageSourceManifest: StorageSourceManifestResponse)

Location of the source in a supported storage service.

Link copied to clipboard
data class StorageSourceManifestResponse(val bucket: String, val generation: String, val object: String)

Location of the source manifest in Google Cloud Storage. This feature is in Preview; see description here.

Link copied to clipboard
data class StorageSourceResponse(val bucket: String, val generation: String, val object: String)

Location of the source in an archive file in Google Cloud Storage.

Link copied to clipboard
data class TimeSpanResponse(val endTime: String, val startTime: String)

Start and end times for a build execution phase.

Link copied to clipboard
data class UploadedMavenArtifactResponse(val fileHashes: FileHashesResponse, val pushTiming: TimeSpanResponse, val uri: String)

A Maven artifact uploaded using the MavenArtifact directive.

Link copied to clipboard
data class UploadedNpmPackageResponse(val fileHashes: FileHashesResponse, val pushTiming: TimeSpanResponse, val uri: String)

An npm package uploaded to Artifact Registry using the NpmPackage directive.

Link copied to clipboard
data class UploadedPythonPackageResponse(val fileHashes: FileHashesResponse, val pushTiming: TimeSpanResponse, val uri: String)

Artifact uploaded using the PythonPackage directive.

Link copied to clipboard
data class VolumeResponse(val name: String, val path: String)

Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.

Link copied to clipboard
data class WarningResponse(val priority: String, val text: String)

A non-fatal problem encountered during the execution of the build.

Link copied to clipboard
data class WebhookConfigResponse(val secret: String, val state: String)

WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.

Link copied to clipboard
data class WorkerConfigResponse(val diskSizeGb: String, val machineType: String)

Defines the configuration to be used for creating workers in the pool.