View Source API Reference google_api_cloud_build v0.50.1

API client metadata for GoogleApi.CloudBuild.V1.

API calls for all endpoints tagged GithubDotComWebhook.

API calls for all endpoints tagged Locations.

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Projects.

API calls for all endpoints tagged V1.

Handle Tesla connections for GoogleApi.CloudBuild.V1.

ApprovalConfig describes configuration for manual approval of a build.

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

Request to approve or reject a pending build.

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

An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.

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

RPC request object accepted by BatchCreateBitbucketServerConnectedRepositories RPC method.

Response of BatchCreateBitbucketServerConnectedRepositories RPC method including all successfully connected Bitbucket Server repositories.

Metadata for BatchCreateBitbucketServerConnectedRepositories operation.

RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.

Response of BatchCreateGitLabConnectedRepositories RPC method.

Metadata for BatchCreateGitLabConnectedRepositories operation.

BitbucketServerConfig represents the configuration for a Bitbucket Server.

/ BitbucketServerConnectedRepository represents a connected Bitbucket Server / repository.

BitbucketServerRepository represents a repository hosted on a Bitbucket Server.

BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.

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

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

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.

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

Metadata for build operations.

Optional arguments to enable specific features of builds.

A step in the build pipeline.

Configuration for an automated build in response to source repository changes.

An image built by the pipeline.

Request to cancel an ongoing build.

The request message for Operations.CancelOperation.

Location of the source in a 2nd-gen Google Cloud Build repository resource.

Metadata for CreateBitbucketServerConfig operation.

Request to connect a repository from a connected Bitbucket Server host.

Metadata for CreateGithubEnterpriseConfig operation.

Metadata for CreateGitLabConfig operation.

Request to connect a repository from a connected GitLab host.

Metadata for the CreateWorkerPool operation.

The default service account used for Builds.

Metadata for DeleteBitbucketServerConfig operation.

Metadata for DeleteGitHubEnterpriseConfig operation.

Metadata for DeleteGitLabConfig operation.

Metadata for the DeleteWorkerPool operation.

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); }

A fatal problem encountered during the execution of the build.

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

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

GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.

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

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

GitLabConfig represents the configuration for a GitLab integration.

GitLabConnectedRepository represents a GitLab connected repository request response.

GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration.

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

Proto Representing a GitLabRepository

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

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

GitRepoSource describes a repo and ref of a code repository.

Location of the source in any accessible Git repository.

Container message for hash values.

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

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

RPC response object returned by ListBitbucketServerConfigs RPC method.

RPC response object returned by the ListBitbucketServerRepositories RPC method.

Response containing existing BuildTriggers.

Response including listed builds.

RPC response object returned by ListGitLabConfigs RPC method.

RPC response object returned by the ListGitLabRepositories RPC method.

RPC response object returned by ListGithubEnterpriseConfigs RPC method.

Response containing existing WorkerPools.

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

Defines the network configuration for the pool.

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

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

Represents the metadata of the long-running operation.

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

Configuration for a V1 PrivatePool.

Metadata for ProcessAppManifestCallback operation.

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

PullRequestFilter contains filter properties for matching GitHub Pull Requests.

Push contains filter properties for matching GitHub git pushes.

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.

ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.

RPC request object accepted by RemoveBitbucketServerConnectedRepository RPC method.

RPC request object accepted by RemoveGitLabConnectedRepository RPC method.

Location of the source in a Google Cloud Source Repository.

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

Artifacts created by the build pipeline.

Specifies a build to retry.

Specifies a build trigger to run and the source to use.

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.

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

Secrets and secret environment variables.

ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection.

Location of the source in a supported storage service.

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

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. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

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

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

Start and end times for a build execution phase.

Metadata for UpdateBitbucketServerConfig operation.

Metadata for UpdateGitHubEnterpriseConfig operation.

Metadata for UpdateGitLabConfig operation.

Metadata for the UpdateWorkerPool operation.

A Maven artifact uploaded using the MavenArtifact directive.

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

Artifact uploaded using the PythonPackage directive.

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

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

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

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

Configuration for a WorkerPool. Cloud Build owns and maintains a pool of workers for general use and have no access to a project's private network. By default, builds submitted to Cloud Build will use a worker from this pool. If your build needs access to resources on a private network, create and use a WorkerPool to run your builds. Private WorkerPools give your builds access to any single VPC network that you administer, including any on-prem resources connected to that VPC network. For an overview of private pools, see Private pools overview.

API client metadata for GoogleApi.CloudBuild.V2.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.CloudBuild.V2.

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Message for creating repositoritories in batch.

Message for response of creating repositories in batch.

Associates members, or principals, with a role.

Configuration for connections to Bitbucket Cloud.

Configuration for connections to Bitbucket Data Center.

The request message for Operations.CancelOperation.

Capabilities adds and removes POSIX capabilities from running containers.

ChildStatusReference is used to point to the statuses of individual TaskRuns and Runs within this PipelineRun.

A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.

Message for creating a Repository.

EmbeddedTask defines a Task that is embedded in a Pipeline.

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); }

Represents an empty Volume source.

Environment variable.

ExecAction describes a "run in container" action.

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Response for fetching git refs

Response message for FetchLinkableRepositories.

Message for fetching SCM read token.

Message for responding to get read token.

Message for fetching SCM read/write token.

Message for responding to get read/write token.

Configuration for connections to github.com.

Conditions defines a readiness condition for a Knative resource.

Configuration for connections to an instance of GitHub Enterprise.

Configuration for connections to gitlab.com or an instance of GitLab Enterprise.

Represents the metadata of the long-running operation.

ServiceDirectoryConfig represents Service Directory configuration for a connection.

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections.

Message for response to listing Connections.

The response message for Locations.ListLocations.

Message for response to listing Repositories.

A resource that represents a Google Cloud location.

Represents an OAuth token of the account that authorized the Connection, and associated metadata.

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

Represents the metadata of the long-running operation.

Param defined with name and value. PipelineRef can be used to refer to a specific instance of a Pipeline.

ParamSpec defines parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.

Parameter value.

PipelineRef can be used to refer to a specific instance of a Pipeline.

A value produced by a Pipeline.

Message describing PipelineRun object

PipelineRunResult used to describe the results of a pipeline

PipelineSpec defines the desired state of Pipeline.

PipelineTask defines a task in a Pipeline.

Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

PropertySpec holds information about a property in an object.

Provenance configuration.

A repository associated to a parent connection.

ResultValue holds different types of data for a single result.

Represents the custom metadata of the RunWorkflow long-running operation.

Secret Volume Source.

Security configuration.

Security options the container should be run with.

Request message for SetIamPolicy method.

Sidecars run alongside the Task's step containers.

SkippedTask is used to describe the Tasks that were skipped due to their When Expressions evaluating to False.

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. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Step embeds the Container type, which allows it to include fields not provided by Container.

StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container.

TaskRef can be used to refer to a specific instance of a task. PipelineRef can be used to refer to a specific instance of a Pipeline.

TaskResult is used to describe the results of a task.

TaskSpec contains the Spec to instantiate a TaskRun.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

TimeoutFields allows granular specification of pipeline, task, and finally timeouts

Represents a personal access token that authorized the Connection, and associated metadata.

Pod volumes to mount into the container's filesystem.

Volumes available to mount.

Conditions that need to be true for the task to run.

Configuration for the worker.

WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used to refer to a specific instance of a Pipeline.

WorkspaceDeclaration is a declaration of a volume that a Task requires.

WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to the workspaces declared in the Task.