The main concept used by this API is a Build, which describes the location of the source to build, how to build the source, and where to store the built artifacts, if any.

A user can list previously-requested builds or get builds by their ID to determine the status of the build. v1

Interfaces

protos.google.api.ICustomHttpPattern

Properties of a CustomHttpPattern.

protos.google.api.IHttp

Properties of a Http.

protos.google.api.IHttpBody

Properties of a HttpBody.

protos.google.api.IHttpRule

Properties of a HttpRule.

protos.google.api.IResourceDescriptor

Properties of a ResourceDescriptor.

protos.google.api.IResourceReference

Properties of a ResourceReference.

protos.google.devtools.cloudbuild.v1.Artifacts.IArtifactObjects

Properties of an ArtifactObjects.

protos.google.devtools.cloudbuild.v1.Artifacts.IMavenArtifact

Properties of a MavenArtifact.

protos.google.devtools.cloudbuild.v1.Artifacts.IPythonPackage

Properties of a PythonPackage.

protos.google.devtools.cloudbuild.v1.Build.IFailureInfo

Properties of a FailureInfo.

protos.google.devtools.cloudbuild.v1.Build.IWarning

Properties of a Warning.

protos.google.devtools.cloudbuild.v1.BuildOptions.IPoolOption

Properties of a PoolOption.

protos.google.devtools.cloudbuild.v1.IApprovalConfig

Properties of an ApprovalConfig.

protos.google.devtools.cloudbuild.v1.IApprovalResult

Properties of an ApprovalResult.

protos.google.devtools.cloudbuild.v1.IApproveBuildRequest

Properties of an ApproveBuildRequest.

protos.google.devtools.cloudbuild.v1.IArtifactResult

Properties of an ArtifactResult.

protos.google.devtools.cloudbuild.v1.IArtifacts

Properties of an Artifacts.

protos.google.devtools.cloudbuild.v1.IBuild

Properties of a Build.

protos.google.devtools.cloudbuild.v1.IBuildApproval

Properties of a BuildApproval.

protos.google.devtools.cloudbuild.v1.IBuildOperationMetadata

Properties of a BuildOperationMetadata.

protos.google.devtools.cloudbuild.v1.IBuildOptions

Properties of a BuildOptions.

protos.google.devtools.cloudbuild.v1.IBuildStep

Properties of a BuildStep.

protos.google.devtools.cloudbuild.v1.IBuildTrigger

Properties of a BuildTrigger.

protos.google.devtools.cloudbuild.v1.IBuiltImage

Properties of a BuiltImage.

protos.google.devtools.cloudbuild.v1.ICancelBuildRequest

Properties of a CancelBuildRequest.

protos.google.devtools.cloudbuild.v1.ICreateBuildRequest

Properties of a CreateBuildRequest.

protos.google.devtools.cloudbuild.v1.ICreateBuildTriggerRequest

Properties of a CreateBuildTriggerRequest.

protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolOperationMetadata

Properties of a CreateWorkerPoolOperationMetadata.

protos.google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest

Properties of a CreateWorkerPoolRequest.

protos.google.devtools.cloudbuild.v1.IDeleteBuildTriggerRequest

Properties of a DeleteBuildTriggerRequest.

protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolOperationMetadata

Properties of a DeleteWorkerPoolOperationMetadata.

protos.google.devtools.cloudbuild.v1.IDeleteWorkerPoolRequest

Properties of a DeleteWorkerPoolRequest.

protos.google.devtools.cloudbuild.v1.IFileHashes

Properties of a FileHashes.

protos.google.devtools.cloudbuild.v1.IGetBuildRequest

Properties of a GetBuildRequest.

protos.google.devtools.cloudbuild.v1.IGetBuildTriggerRequest

Properties of a GetBuildTriggerRequest.

protos.google.devtools.cloudbuild.v1.IGetWorkerPoolRequest

Properties of a GetWorkerPoolRequest.

protos.google.devtools.cloudbuild.v1.IGitHubEventsConfig

Properties of a GitHubEventsConfig.

protos.google.devtools.cloudbuild.v1.IHash

Properties of a Hash.

protos.google.devtools.cloudbuild.v1.IInlineSecret

Properties of an InlineSecret.

protos.google.devtools.cloudbuild.v1.IListBuildsRequest

Properties of a ListBuildsRequest.

protos.google.devtools.cloudbuild.v1.IListBuildsResponse

Properties of a ListBuildsResponse.

protos.google.devtools.cloudbuild.v1.IListBuildTriggersRequest

Properties of a ListBuildTriggersRequest.

protos.google.devtools.cloudbuild.v1.IListBuildTriggersResponse

Properties of a ListBuildTriggersResponse.

protos.google.devtools.cloudbuild.v1.IListWorkerPoolsRequest

Properties of a ListWorkerPoolsRequest.

protos.google.devtools.cloudbuild.v1.IListWorkerPoolsResponse

Properties of a ListWorkerPoolsResponse.

protos.google.devtools.cloudbuild.v1.IPrivatePoolV1Config

Properties of a PrivatePoolV1Config.

protos.google.devtools.cloudbuild.v1.IPubsubConfig

Properties of a PubsubConfig.

protos.google.devtools.cloudbuild.v1.IPullRequestFilter

Properties of a PullRequestFilter.

protos.google.devtools.cloudbuild.v1.IPushFilter

Properties of a PushFilter.

protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookRequest

Properties of a ReceiveTriggerWebhookRequest.

protos.google.devtools.cloudbuild.v1.IReceiveTriggerWebhookResponse

Properties of a ReceiveTriggerWebhookResponse.

protos.google.devtools.cloudbuild.v1.IRepoSource

Properties of a RepoSource.

protos.google.devtools.cloudbuild.v1.IResults

Properties of a Results.

protos.google.devtools.cloudbuild.v1.IRetryBuildRequest

Properties of a RetryBuildRequest.

protos.google.devtools.cloudbuild.v1.IRunBuildTriggerRequest

Properties of a RunBuildTriggerRequest.

protos.google.devtools.cloudbuild.v1.ISecret

Properties of a Secret.

protos.google.devtools.cloudbuild.v1.ISecretManagerSecret

Properties of a SecretManagerSecret.

protos.google.devtools.cloudbuild.v1.ISecrets

Properties of a Secrets.

protos.google.devtools.cloudbuild.v1.ISource

Properties of a Source.

protos.google.devtools.cloudbuild.v1.ISourceProvenance

Properties of a SourceProvenance.

protos.google.devtools.cloudbuild.v1.IStorageSource

Properties of a StorageSource.

protos.google.devtools.cloudbuild.v1.IStorageSourceManifest

Properties of a StorageSourceManifest.

protos.google.devtools.cloudbuild.v1.ITimeSpan

Properties of a TimeSpan.

protos.google.devtools.cloudbuild.v1.IUpdateBuildTriggerRequest

Properties of an UpdateBuildTriggerRequest.

protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolOperationMetadata

Properties of an UpdateWorkerPoolOperationMetadata.

protos.google.devtools.cloudbuild.v1.IUpdateWorkerPoolRequest

Properties of an UpdateWorkerPoolRequest.

protos.google.devtools.cloudbuild.v1.IUploadedMavenArtifact

Properties of an UploadedMavenArtifact.

protos.google.devtools.cloudbuild.v1.IUploadedPythonPackage

Properties of an UploadedPythonPackage.

protos.google.devtools.cloudbuild.v1.IVolume

Properties of a Volume.

protos.google.devtools.cloudbuild.v1.IWebhookConfig

Properties of a WebhookConfig.

protos.google.devtools.cloudbuild.v1.IWorkerPool

Properties of a WorkerPool.

protos.google.devtools.cloudbuild.v1.PrivatePoolV1Config.INetworkConfig

Properties of a NetworkConfig.

protos.google.devtools.cloudbuild.v1.PrivatePoolV1Config.IWorkerConfig

Properties of a WorkerConfig.

protos.google.longrunning.ICancelOperationRequest

Properties of a CancelOperationRequest.

protos.google.longrunning.IDeleteOperationRequest

Properties of a DeleteOperationRequest.

protos.google.longrunning.IGetOperationRequest

Properties of a GetOperationRequest.

protos.google.longrunning.IListOperationsRequest

Properties of a ListOperationsRequest.

protos.google.longrunning.IListOperationsResponse

Properties of a ListOperationsResponse.

protos.google.longrunning.IOperation

Properties of an Operation.

protos.google.longrunning.IOperationInfo

Properties of an OperationInfo.

protos.google.longrunning.IWaitOperationRequest

Properties of a WaitOperationRequest.

protos.google.protobuf.DescriptorProto.IExtensionRange

Properties of an ExtensionRange.

protos.google.protobuf.DescriptorProto.IReservedRange

Properties of a ReservedRange.

protos.google.protobuf.EnumDescriptorProto.IEnumReservedRange

Properties of an EnumReservedRange.

protos.google.protobuf.GeneratedCodeInfo.IAnnotation

Properties of an Annotation.

protos.google.protobuf.IAny

Properties of an Any.

protos.google.protobuf.IDescriptorProto

Properties of a DescriptorProto.

protos.google.protobuf.IDuration

Properties of a Duration.

protos.google.protobuf.IEmpty

Properties of an Empty.

protos.google.protobuf.IEnumDescriptorProto

Properties of an EnumDescriptorProto.

protos.google.protobuf.IEnumOptions

Properties of an EnumOptions.

protos.google.protobuf.IEnumValueDescriptorProto

Properties of an EnumValueDescriptorProto.

protos.google.protobuf.IEnumValueOptions

Properties of an EnumValueOptions.

protos.google.protobuf.IExtensionRangeOptions

Properties of an ExtensionRangeOptions.

protos.google.protobuf.IFieldDescriptorProto

Properties of a FieldDescriptorProto.

protos.google.protobuf.IFieldMask

Properties of a FieldMask.

protos.google.protobuf.IFieldOptions

Properties of a FieldOptions.

protos.google.protobuf.IFileDescriptorProto

Properties of a FileDescriptorProto.

protos.google.protobuf.IFileDescriptorSet

Properties of a FileDescriptorSet.

protos.google.protobuf.IFileOptions

Properties of a FileOptions.

protos.google.protobuf.IGeneratedCodeInfo

Properties of a GeneratedCodeInfo.

protos.google.protobuf.IMessageOptions

Properties of a MessageOptions.

protos.google.protobuf.IMethodDescriptorProto

Properties of a MethodDescriptorProto.

protos.google.protobuf.IMethodOptions

Properties of a MethodOptions.

protos.google.protobuf.IOneofDescriptorProto

Properties of an OneofDescriptorProto.

protos.google.protobuf.IOneofOptions

Properties of an OneofOptions.

protos.google.protobuf.IServiceDescriptorProto

Properties of a ServiceDescriptorProto.

protos.google.protobuf.IServiceOptions

Properties of a ServiceOptions.

protos.google.protobuf.ISourceCodeInfo

Properties of a SourceCodeInfo.

protos.google.protobuf.ITimestamp

Properties of a Timestamp.

protos.google.protobuf.IUninterpretedOption

Properties of an UninterpretedOption.

protos.google.protobuf.SourceCodeInfo.ILocation

Properties of a Location.

protos.google.protobuf.UninterpretedOption.INamePart

Properties of a NamePart.

protos.google.rpc.IStatus

Properties of a Status.

Enums

protos.google.api.FieldBehavior

FieldBehavior enum.

protos.google.api.ResourceDescriptor.History

History enum.

protos.google.api.ResourceDescriptor.Style

Style enum.

protos.google.devtools.cloudbuild.v1.ApprovalResult.Decision

Decision enum.

protos.google.devtools.cloudbuild.v1.Build.FailureInfo.FailureType

FailureType enum.

protos.google.devtools.cloudbuild.v1.Build.Status

Status enum.

protos.google.devtools.cloudbuild.v1.Build.Warning.Priority

Priority enum.

protos.google.devtools.cloudbuild.v1.BuildApproval.State

State enum.

protos.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode

LoggingMode enum.

protos.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption

LogStreamingOption enum.

protos.google.devtools.cloudbuild.v1.BuildOptions.MachineType

MachineType enum.

protos.google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption

SubstitutionOption enum.

protos.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption

VerifyOption enum.

protos.google.devtools.cloudbuild.v1.Hash.HashType

HashType enum.

protos.google.devtools.cloudbuild.v1.PrivatePoolV1Config.NetworkConfig.EgressOption

EgressOption enum.

protos.google.devtools.cloudbuild.v1.PubsubConfig.State

State enum.

protos.google.devtools.cloudbuild.v1.PullRequestFilter.CommentControl

CommentControl enum.

protos.google.devtools.cloudbuild.v1.WebhookConfig.State

State enum.

protos.google.devtools.cloudbuild.v1.WorkerPool.State

State enum.

protos.google.protobuf.FieldDescriptorProto.Label

Label enum.

protos.google.protobuf.FieldDescriptorProto.Type

Type enum.

protos.google.protobuf.FieldOptions.CType

CType enum.

protos.google.protobuf.FieldOptions.JSType

JSType enum.

protos.google.protobuf.FileOptions.OptimizeMode

OptimizeMode enum.

protos.google.protobuf.GeneratedCodeInfo.Annotation.Semantic

Semantic enum.

protos.google.protobuf.MethodOptions.IdempotencyLevel

IdempotencyLevel enum.

Variables

_default

_default: {
    v1: typeof v1;
    CloudBuildClient: typeof v1.CloudBuildClient;
}

CloudBuildClient

CloudBuildClient: typeof v1.CloudBuildClient

Type Aliases

CloudBuildClient

declare type CloudBuildClient = v1.CloudBuildClient;

protos.google.devtools.cloudbuild.v1.CloudBuild.ApproveBuildCallback

type ApproveBuildCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.CancelBuildCallback

type CancelBuildCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.Build) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.CreateBuildCallback

type CreateBuildCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.CreateBuildTriggerCallback

type CreateBuildTriggerCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.BuildTrigger) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.CreateWorkerPoolCallback

type CreateWorkerPoolCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.DeleteBuildTriggerCallback

type DeleteBuildTriggerCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.DeleteWorkerPoolCallback

type DeleteWorkerPoolCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.GetBuildCallback

type GetBuildCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.Build) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.GetBuildTriggerCallback

type GetBuildTriggerCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.BuildTrigger) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.GetWorkerPoolCallback

type GetWorkerPoolCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.WorkerPool) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.ListBuildsCallback

type ListBuildsCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.ListBuildsResponse) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.ListBuildTriggersCallback

type ListBuildTriggersCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.ListBuildTriggersResponse) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.ListWorkerPoolsCallback

type ListWorkerPoolsCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.ListWorkerPoolsResponse) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.ReceiveTriggerWebhookCallback

type ReceiveTriggerWebhookCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.ReceiveTriggerWebhookResponse) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.RetryBuildCallback

type RetryBuildCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.RunBuildTriggerCallback

type RunBuildTriggerCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.UpdateBuildTriggerCallback

type UpdateBuildTriggerCallback = (error: (Error|null), response?: google.devtools.cloudbuild.v1.BuildTrigger) => void;

Callback as used by .

protos.google.devtools.cloudbuild.v1.CloudBuild.UpdateWorkerPoolCallback

type UpdateWorkerPoolCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.longrunning.Operations.CancelOperationCallback

type CancelOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.DeleteOperationCallback

type DeleteOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.GetOperationCallback

type GetOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.longrunning.Operations.ListOperationsCallback

type ListOperationsCallback = (error: (Error|null), response?: google.longrunning.ListOperationsResponse) => void;

Callback as used by .

protos.google.longrunning.Operations.WaitOperationCallback

type WaitOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .