Class Build

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.

Inheritance
object
Build
Implements
Inherited Members
Namespace: Google.Apis.CloudBuild.v1.Data
Assembly: Google.Apis.CloudBuild.v1.dll
Syntax
public class Build : IDirectResponseSchema

Properties

Approval

Output only. Describes this build's approval configuration, status, and result.

Declaration
[JsonProperty("approval")]
public virtual BuildApproval Approval { get; set; }
Property Value
Type Description
BuildApproval

Artifacts

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

Declaration
[JsonProperty("artifacts")]
public virtual Artifacts Artifacts { get; set; }
Property Value
Type Description
Artifacts

AvailableSecrets

Secrets and secret environment variables.

Declaration
[JsonProperty("availableSecrets")]
public virtual Secrets AvailableSecrets { get; set; }
Property Value
Type Description
Secrets

BuildTriggerId

Output only. The ID of the BuildTrigger that triggered this build, if it was triggered automatically.

Declaration
[JsonProperty("buildTriggerId")]
public virtual string BuildTriggerId { get; set; }
Property Value
Type Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Time at which the request to create the build was received.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FailureInfo

Output only. Contains information about the build when status=FAILURE.

Declaration
[JsonProperty("failureInfo")]
public virtual FailureInfo FailureInfo { get; set; }
Property Value
Type Description
FailureInfo

FinishTime

object representation of FinishTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use FinishTimeDateTimeOffset instead.")]
public virtual object FinishTime { get; set; }
Property Value
Type Description
object

FinishTimeDateTimeOffset

DateTimeOffset representation of FinishTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? FinishTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

FinishTimeRaw

Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.

Declaration
[JsonProperty("finishTime")]
public virtual string FinishTimeRaw { get; set; }
Property Value
Type Description
string

Id

Output only. Unique identifier of the build.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

Images

A list of images to be pushed upon the successful completion of all build steps. The images are 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 status is marked FAILURE.

Declaration
[JsonProperty("images")]
public virtual IList<string> Images { get; set; }
Property Value
Type Description
IList<string>

LogsBucket

Cloud Storage bucket where logs should be written (see Bucket Name Requirements). Logs file names will be of the format ${logs_bucket}/log-${build_id}.txt.

Declaration
[JsonProperty("logsBucket")]
public virtual string LogsBucket { get; set; }
Property Value
Type Description
string

LogUrl

Output only. URL to logs for this build in Google Cloud Console.

Declaration
[JsonProperty("logUrl")]
public virtual string LogUrl { get; set; }
Property Value
Type Description
string

Name

Output only. The 'Build' name with format: projects/{project}/locations/{location}/builds/{build}, where {build} is a unique identifier generated by the service.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Options

Special options for this build.

Declaration
[JsonProperty("options")]
public virtual BuildOptions Options { get; set; }
Property Value
Type Description
BuildOptions

ProjectId

Output only. ID of the project.

Declaration
[JsonProperty("projectId")]
public virtual string ProjectId { get; set; }
Property Value
Type Description
string

QueueTtl

TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be EXPIRED. The TTL starts ticking from create_time.

Declaration
[JsonProperty("queueTtl")]
public virtual object QueueTtl { get; set; }
Property Value
Type Description
object

Results

Output only. Results of the build.

Declaration
[JsonProperty("results")]
public virtual Results Results { get; set; }
Property Value
Type Description
Results

Secrets

Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use available_secrets to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets

Declaration
[JsonProperty("secrets")]
public virtual IList<Secret> Secrets { get; set; }
Property Value
Type Description
IList<Secret>

ServiceAccount

IAM service account whose credentials will be used at build runtime. Must be of the format projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. ACCOUNT can be email address or uniqueId of the service account.

Declaration
[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }
Property Value
Type Description
string

Source

The location of the source files to build.

Declaration
[JsonProperty("source")]
public virtual Source Source { get; set; }
Property Value
Type Description
Source

SourceProvenance

Output only. A permanent fixed identifier for source.

Declaration
[JsonProperty("sourceProvenance")]
public virtual SourceProvenance SourceProvenance { get; set; }
Property Value
Type Description
SourceProvenance

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

Output only. Time at which execution of the build was started.

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

Status

Output only. Status of the build.

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

StatusDetail

Output only. Customer-readable message about the current status.

Declaration
[JsonProperty("statusDetail")]
public virtual string StatusDetail { get; set; }
Property Value
Type Description
string

Steps

Required. The operations to be performed on the workspace.

Declaration
[JsonProperty("steps")]
public virtual IList<BuildStep> Steps { get; set; }
Property Value
Type Description
IList<BuildStep>

Substitutions

Substitutions data for Build resource.

Declaration
[JsonProperty("substitutions")]
public virtual IDictionary<string, string> Substitutions { get; set; }
Property Value
Type Description
IDictionary<string, string>

Tags

Tags for annotation of a Build. These are not docker tags.

Declaration
[JsonProperty("tags")]
public virtual IList<string> Tags { get; set; }
Property Value
Type Description
IList<string>

Timeout

Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be TIMEOUT. timeout starts ticking from startTime. Default time is 60 minutes.

Declaration
[JsonProperty("timeout")]
public virtual object Timeout { get; set; }
Property Value
Type Description
object

Timing

Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.

Declaration
[JsonProperty("timing")]
public virtual IDictionary<string, TimeSpan> Timing { get; set; }
Property Value
Type Description
IDictionary<string, TimeSpan>

Warnings

Output only. Non-fatal problems encountered during the execution of the build.

Declaration
[JsonProperty("warnings")]
public virtual IList<Warning> Warnings { get; set; }
Property Value
Type Description
IList<Warning>

Implements