Class Build (3.8.0)

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.
• $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.

Protobuf type google.devtools.cloudbuild.v1.Build

Substitutions data for Build resource.

map<string, string> substitutions = 29;

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 specified images.
• 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.

map<string, .google.devtools.cloudbuild.v1.TimeSpan> timing = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.devtools.cloudbuild.v1.BuildApproval approval = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.devtools.cloudbuild.v1.BuildApproval approval = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.devtools.cloudbuild.v1.Artifacts artifacts = 37;

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

.google.devtools.cloudbuild.v1.Artifacts artifacts = 37;

Secrets and secret environment variables.

.google.devtools.cloudbuild.v1.Secrets available_secrets = 47;

Secrets and secret environment variables.

.google.devtools.cloudbuild.v1.Secrets available_secrets = 47;

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

string build_trigger_id = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

string build_trigger_id = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.devtools.cloudbuild.v1.Build.FailureInfo failure_info = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.devtools.cloudbuild.v1.Build.FailureInfo failure_info = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

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.

.google.protobuf.Timestamp finish_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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.

.google.protobuf.Timestamp finish_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. Unique identifier of the build.

string id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. Unique identifier of the build.

string id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 .

repeated string images = 13;

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 .

repeated string images = 13;

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 .

repeated string images = 13;

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 .

repeated string images = 13;

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

string log_url = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

string log_url = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Google 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 .

string logs_bucket = 19;

Google 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 .

string logs_bucket = 19;

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

string name = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

string name = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Special options for this build.

.google.devtools.cloudbuild.v1.BuildOptions options = 23;

Special options for this build.

.google.devtools.cloudbuild.v1.BuildOptions options = 23;

Output only. ID of the project.

string project_id = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. ID of the project.

string project_id = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

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.

.google.protobuf.Duration queue_ttl = 40;

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.

.google.protobuf.Duration queue_ttl = 40;

Output only. Results of the build.

.google.devtools.cloudbuild.v1.Results results = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. Results of the build.

.google.devtools.cloudbuild.v1.Results results = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

repeated .google.devtools.cloudbuild.v1.Secret secrets = 32;

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

repeated .google.devtools.cloudbuild.v1.Secret secrets = 32;

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

repeated .google.devtools.cloudbuild.v1.Secret secrets = 32;

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

repeated .google.devtools.cloudbuild.v1.Secret secrets = 32;

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

repeated .google.devtools.cloudbuild.v1.Secret secrets = 32;

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.

string service_account = 42 [(.google.api.resource_reference) = { ... }

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.

string service_account = 42 [(.google.api.resource_reference) = { ... }

The location of the source files to build.

.google.devtools.cloudbuild.v1.Source source = 3;

The location of the source files to build.

.google.devtools.cloudbuild.v1.Source source = 3;

Output only. A permanent fixed identifier for source.

.google.devtools.cloudbuild.v1.SourceProvenance source_provenance = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. A permanent fixed identifier for source.

.google.devtools.cloudbuild.v1.SourceProvenance source_provenance = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. Status of the build.

.google.devtools.cloudbuild.v1.Build.Status status = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

string status_detail = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

string status_detail = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. Status of the build.

.google.devtools.cloudbuild.v1.Build.Status status = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Required. The operations to be performed on the workspace.

repeated .google.devtools.cloudbuild.v1.BuildStep steps = 11;

Required. The operations to be performed on the workspace.

repeated .google.devtools.cloudbuild.v1.BuildStep steps = 11;

Required. The operations to be performed on the workspace.

repeated .google.devtools.cloudbuild.v1.BuildStep steps = 11;

Required. The operations to be performed on the workspace.

repeated .google.devtools.cloudbuild.v1.BuildStep steps = 11;

Required. The operations to be performed on the workspace.

repeated .google.devtools.cloudbuild.v1.BuildStep steps = 11;

Use #getSubstitutionsMap() instead.

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Substitutions data for Build resource.

map<string, string> substitutions = 29;

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

repeated string tags = 31;

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

repeated string tags = 31;

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

repeated string tags = 31;

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

repeated string tags = 31;

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 ten minutes.

.google.protobuf.Duration timeout = 12;

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 ten minutes.

.google.protobuf.Duration timeout = 12;

Use #getTimingMap() instead.

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 specified images.
• 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.

map<string, .google.devtools.cloudbuild.v1.TimeSpan> timing = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 specified images.
• 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.

map<string, .google.devtools.cloudbuild.v1.TimeSpan> timing = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 specified images.
• 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.

map<string, .google.devtools.cloudbuild.v1.TimeSpan> timing = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 specified images.
• 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.

map<string, .google.devtools.cloudbuild.v1.TimeSpan> timing = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

repeated .google.devtools.cloudbuild.v1.Build.Warning warnings = 49 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

repeated .google.devtools.cloudbuild.v1.Build.Warning warnings = 49 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

repeated .google.devtools.cloudbuild.v1.Build.Warning warnings = 49 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

repeated .google.devtools.cloudbuild.v1.Build.Warning warnings = 49 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

repeated .google.devtools.cloudbuild.v1.Build.Warning warnings = 49 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.devtools.cloudbuild.v1.BuildApproval approval = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.devtools.cloudbuild.v1.Artifacts artifacts = 37;

Secrets and secret environment variables.

.google.devtools.cloudbuild.v1.Secrets available_secrets = 47;

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

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.devtools.cloudbuild.v1.Build.FailureInfo failure_info = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

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.

.google.protobuf.Timestamp finish_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Special options for this build.

.google.devtools.cloudbuild.v1.BuildOptions options = 23;

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.

.google.protobuf.Duration queue_ttl = 40;

Output only. Results of the build.

.google.devtools.cloudbuild.v1.Results results = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

The location of the source files to build.

.google.devtools.cloudbuild.v1.Source source = 3;

Output only. A permanent fixed identifier for source.

.google.devtools.cloudbuild.v1.SourceProvenance source_provenance = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 ten minutes.

.google.protobuf.Duration timeout = 12;