Package-level declarations

Types

Link copied to clipboard
data class ApprovalConfigArgs(val approvalRequired: Output<Boolean>? = null) : ConvertibleToJava<ApprovalConfigArgs>

ApprovalConfig describes configuration for manual approval of a build.

Link copied to clipboard
Link copied to clipboard
data class ArtifactObjectsArgs(val location: Output<String>? = null, val paths: Output<List<String>>? = null) : ConvertibleToJava<ArtifactObjectsArgs>

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

Link copied to clipboard
data class ArtifactsArgs(val images: Output<List<String>>? = null, val mavenArtifacts: Output<List<MavenArtifactArgs>>? = null, val npmPackages: Output<List<NpmPackageArgs>>? = null, val objects: Output<ArtifactObjectsArgs>? = null, val pythonPackages: Output<List<PythonPackageArgs>>? = null) : ConvertibleToJava<ArtifactsArgs>

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

Link copied to clipboard
Link copied to clipboard
data class BitbucketServerSecretsArgs(val adminAccessTokenVersionName: Output<String>, val readAccessTokenVersionName: Output<String>, val webhookSecretVersionName: Output<String>) : ConvertibleToJava<BitbucketServerSecretsArgs>

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

Link copied to clipboard
data class BitbucketServerTriggerConfigArgs(val bitbucketServerConfigResource: Output<String>, val projectKey: Output<String>, val pullRequest: Output<PullRequestFilterArgs>? = null, val push: Output<PushFilterArgs>? = null, val repoSlug: Output<String>) : ConvertibleToJava<BitbucketServerTriggerConfigArgs>

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

Link copied to clipboard
data class BuildArgs(val artifacts: Output<ArtifactsArgs>? = null, val availableSecrets: Output<SecretsArgs>? = null, val images: Output<List<String>>? = null, val logsBucket: Output<String>? = null, val options: Output<BuildOptionsArgs>? = null, val queueTtl: Output<String>? = null, val secrets: Output<List<SecretArgs>>? = null, val serviceAccount: Output<String>? = null, val source: Output<SourceArgs>? = null, val steps: Output<List<BuildStepArgs>>, val substitutions: Output<Map<String, String>>? = null, val tags: Output<List<String>>? = null, val timeout: Output<String>? = null) : ConvertibleToJava<BuildArgs>

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

Builder for BuildArgs.

Link copied to clipboard
data class BuildOptionsArgs(val defaultLogsBucketBehavior: Output<BuildOptionsDefaultLogsBucketBehavior>? = null, val diskSizeGb: Output<String>? = null, val dynamicSubstitutions: Output<Boolean>? = null, val env: Output<List<String>>? = null, val logStreamingOption: Output<BuildOptionsLogStreamingOption>? = null, val logging: Output<BuildOptionsLogging>? = null, val machineType: Output<BuildOptionsMachineType>? = null, val pool: Output<PoolOptionArgs>? = null, val requestedVerifyOption: Output<BuildOptionsRequestedVerifyOption>? = null, val secretEnv: Output<List<String>>? = null, val sourceProvenanceHash: Output<List<BuildOptionsSourceProvenanceHashItem>>? = null, val substitutionOption: Output<BuildOptionsSubstitutionOption>? = null, val volumes: Output<List<VolumeArgs>>? = null, val workerPool: Output<String>? = null) : ConvertibleToJava<BuildOptionsArgs>

Optional arguments to enable specific features of builds.

Link copied to clipboard
Link copied to clipboard
data class BuildStepArgs(val allowExitCodes: Output<List<Int>>? = null, val allowFailure: Output<Boolean>? = null, val args: Output<List<String>>? = null, val dir: Output<String>? = null, val entrypoint: Output<String>? = null, val env: Output<List<String>>? = null, val id: Output<String>? = null, val name: Output<String>, val script: Output<String>? = null, val secretEnv: Output<List<String>>? = null, val timeout: Output<String>? = null, val volumes: Output<List<VolumeArgs>>? = null, val waitFor: Output<List<String>>? = null) : ConvertibleToJava<BuildStepArgs>

A step in the build pipeline.

Link copied to clipboard
Link copied to clipboard
data class GetBitbucketServerConfigPlainArgs(val bitbucketServerConfigId: String, val location: String, val project: String? = null) : ConvertibleToJava<GetBitbucketServerConfigPlainArgs>
Link copied to clipboard
data class GetBuildPlainArgs(val buildId: String, val id: String, val location: String, val project: String? = null, val projectId: String) : ConvertibleToJava<GetBuildPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class GetGithubEnterpriseConfigPlainArgs(val configId: String? = null, val githubEnterpriseConfigId: String, val location: String, val project: String? = null, val projectId: String? = null) : ConvertibleToJava<GetGithubEnterpriseConfigPlainArgs>
Link copied to clipboard
data class GetGitLabConfigPlainArgs(val gitLabConfigId: String, val location: String, val project: String? = null) : ConvertibleToJava<GetGitLabConfigPlainArgs>
Link copied to clipboard
data class GetTriggerPlainArgs(val location: String, val project: String? = null, val projectId: String, val triggerId: String) : ConvertibleToJava<GetTriggerPlainArgs>
Link copied to clipboard
data class GetWorkerPoolPlainArgs(val location: String, val project: String? = null, val workerPoolId: String) : ConvertibleToJava<GetWorkerPoolPlainArgs>
Link copied to clipboard
data class GitFileSourceArgs(val bitbucketServerConfig: Output<String>? = null, val githubEnterpriseConfig: Output<String>? = null, val path: Output<String>? = null, val repoType: Output<GitFileSourceRepoType>? = null, val repository: Output<String>? = null, val revision: Output<String>? = null, val uri: Output<String>? = null) : ConvertibleToJava<GitFileSourceArgs>

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

Link copied to clipboard
Link copied to clipboard
data class GitHubEnterpriseSecretsArgs(val oauthClientIdName: Output<String>? = null, val oauthClientIdVersionName: Output<String>? = null, val oauthSecretName: Output<String>? = null, val oauthSecretVersionName: Output<String>? = null, val privateKeyName: Output<String>? = null, val privateKeyVersionName: Output<String>? = null, val webhookSecretName: Output<String>? = null, val webhookSecretVersionName: Output<String>? = null) : ConvertibleToJava<GitHubEnterpriseSecretsArgs>

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 GitHubEventsConfigArgs(val enterpriseConfigResourceName: Output<String>? = null, val installationId: Output<String>? = null, val name: Output<String>? = null, val owner: Output<String>? = null, val pullRequest: Output<PullRequestFilterArgs>? = null, val push: Output<PushFilterArgs>? = null) : ConvertibleToJava<GitHubEventsConfigArgs>

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

Link copied to clipboard
data class GitLabEnterpriseConfigArgs(val hostUri: Output<String>? = null, val serviceDirectoryConfig: Output<ServiceDirectoryConfigArgs>? = null, val sslCa: Output<String>? = null) : ConvertibleToJava<GitLabEnterpriseConfigArgs>

GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration.

Link copied to clipboard
data class GitLabEventsConfigArgs(val gitlabConfigResource: Output<String>? = null, val projectNamespace: Output<String>? = null, val pullRequest: Output<PullRequestFilterArgs>? = null, val push: Output<PushFilterArgs>? = null) : ConvertibleToJava<GitLabEventsConfigArgs>

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

Link copied to clipboard
data class GitLabRepositoryIdArgs(val id: Output<String>) : ConvertibleToJava<GitLabRepositoryIdArgs>

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

Link copied to clipboard
data class GitLabSecretsArgs(val apiAccessTokenVersion: Output<String>, val apiKeyVersion: Output<String>, val readAccessTokenVersion: Output<String>, val webhookSecretVersion: Output<String>) : ConvertibleToJava<GitLabSecretsArgs>

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

Link copied to clipboard
Link copied to clipboard
data class GitRepoSourceArgs(val bitbucketServerConfig: Output<String>? = null, val githubEnterpriseConfig: Output<String>? = null, val ref: Output<String>? = null, val repoType: Output<GitRepoSourceRepoType>? = null, val repository: Output<String>? = null, val uri: Output<String>? = null) : ConvertibleToJava<GitRepoSourceArgs>

GitRepoSource describes a repo and ref of a code repository.

Link copied to clipboard
Link copied to clipboard
data class GitSourceArgs(val dir: Output<String>? = null, val revision: Output<String>? = null, val url: Output<String>? = null) : ConvertibleToJava<GitSourceArgs>

Location of the source in any accessible Git repository.

Link copied to clipboard
Link copied to clipboard
data class InlineSecretArgs(val envMap: Output<Map<String, String>>? = null, val kmsKeyName: Output<String>? = null) : ConvertibleToJava<InlineSecretArgs>

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
Link copied to clipboard
data class MavenArtifactArgs(val artifactId: Output<String>? = null, val groupId: Output<String>? = null, val path: Output<String>? = null, val repository: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<MavenArtifactArgs>

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

Link copied to clipboard
Link copied to clipboard
data class NetworkConfigArgs(val egressOption: Output<NetworkConfigEgressOption>? = null, val peeredNetwork: Output<String>, val peeredNetworkIpRange: Output<String>? = null) : ConvertibleToJava<NetworkConfigArgs>

Defines the network configuration for the pool.

Link copied to clipboard
Link copied to clipboard
data class NpmPackageArgs(val packagePath: Output<String>? = null, val repository: Output<String>? = null) : ConvertibleToJava<NpmPackageArgs>

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

Link copied to clipboard
Link copied to clipboard
data class PoolOptionArgs(val name: Output<String>? = null) : ConvertibleToJava<PoolOptionArgs>

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
Link copied to clipboard
data class PrivatePoolV1ConfigArgs(val networkConfig: Output<NetworkConfigArgs>? = null, val workerConfig: Output<WorkerConfigArgs>? = null) : ConvertibleToJava<PrivatePoolV1ConfigArgs>

Configuration for a V1 PrivatePool.

Link copied to clipboard
data class PubsubConfigArgs(val serviceAccountEmail: Output<String>? = null, val state: Output<PubsubConfigState>? = null, val topic: Output<String>? = null) : ConvertibleToJava<PubsubConfigArgs>

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

Link copied to clipboard
Link copied to clipboard
data class PullRequestFilterArgs(val branch: Output<String>? = null, val commentControl: Output<PullRequestFilterCommentControl>? = null, val invertRegex: Output<Boolean>? = null) : ConvertibleToJava<PullRequestFilterArgs>

PullRequestFilter contains filter properties for matching GitHub Pull Requests.

Link copied to clipboard
data class PushFilterArgs(val branch: Output<String>? = null, val invertRegex: Output<Boolean>? = null, val tag: Output<String>? = null) : ConvertibleToJava<PushFilterArgs>

Push contains filter properties for matching GitHub git pushes.

Link copied to clipboard
Link copied to clipboard
data class PythonPackageArgs(val paths: Output<List<String>>? = null, val repository: Output<String>? = null) : ConvertibleToJava<PythonPackageArgs>

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
Link copied to clipboard
data class RepositoryEventConfigArgs(val pullRequest: Output<PullRequestFilterArgs>? = null, val push: Output<PushFilterArgs>? = null, val repository: Output<String>? = null) : ConvertibleToJava<RepositoryEventConfigArgs>

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

Link copied to clipboard
data class RepoSourceArgs(val branchName: Output<String>? = null, val commitSha: Output<String>? = null, val dir: Output<String>? = null, val invertRegex: Output<Boolean>? = null, val project: Output<String>? = null, val repoName: Output<String>? = null, val substitutions: Output<Map<String, String>>? = null, val tagName: Output<String>? = null) : ConvertibleToJava<RepoSourceArgs>

Location of the source in a Google Cloud Source Repository.

Link copied to clipboard
Link copied to clipboard
data class SecretArgs(val kmsKeyName: Output<String>? = null, val secretEnv: Output<Map<String, String>>? = null) : ConvertibleToJava<SecretArgs>

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

Builder for SecretArgs.

Link copied to clipboard
data class SecretManagerSecretArgs(val env: Output<String>? = null, val versionName: Output<String>? = null) : ConvertibleToJava<SecretManagerSecretArgs>

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

Link copied to clipboard
data class SecretsArgs(val inline: Output<List<InlineSecretArgs>>? = null, val secretManager: Output<List<SecretManagerSecretArgs>>? = null) : ConvertibleToJava<SecretsArgs>

Secrets and secret environment variables.

Link copied to clipboard
Link copied to clipboard
data class ServiceDirectoryConfigArgs(val service: Output<String>? = null) : ConvertibleToJava<ServiceDirectoryConfigArgs>

ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection.

Link copied to clipboard
data class SourceArgs(val gitSource: Output<GitSourceArgs>? = null, val repoSource: Output<RepoSourceArgs>? = null, val storageSource: Output<StorageSourceArgs>? = null, val storageSourceManifest: Output<StorageSourceManifestArgs>? = null) : ConvertibleToJava<SourceArgs>

Location of the source in a supported storage service.

Link copied to clipboard

Builder for SourceArgs.

Link copied to clipboard
data class StorageSourceArgs(val bucket: Output<String>? = null, val generation: Output<String>? = null, val object: Output<String>? = null) : ConvertibleToJava<StorageSourceArgs>

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

Link copied to clipboard
Link copied to clipboard
data class StorageSourceManifestArgs(val bucket: Output<String>? = null, val generation: Output<String>? = null, val object: Output<String>? = null) : ConvertibleToJava<StorageSourceManifestArgs>

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

Link copied to clipboard
data class VolumeArgs(val name: Output<String>? = null, val path: Output<String>? = null) : ConvertibleToJava<VolumeArgs>

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

Builder for VolumeArgs.

Link copied to clipboard
data class WebhookConfigArgs(val secret: Output<String>, val state: Output<WebhookConfigState>? = null) : ConvertibleToJava<WebhookConfigArgs>

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
Link copied to clipboard
data class WorkerConfigArgs(val diskSizeGb: Output<String>? = null, val machineType: Output<String>? = null) : ConvertibleToJava<WorkerConfigArgs>

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

Link copied to clipboard