Build (Cloud Build API v1-rev20240427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudbuild.v1.model.Build

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Build
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Build API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Build()

Constructors
Constructor and Description
`Build()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Build`	`clone()`
`BuildApproval`	`getApproval()` Output only.
`Artifacts`	`getArtifacts()` Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
`Secrets`	`getAvailableSecrets()` Secrets and secret environment variables.
`String`	`getBuildTriggerId()` Output only.
`String`	`getCreateTime()` Output only.
`FailureInfo`	`getFailureInfo()` Output only.
`String`	`getFinishTime()` Output only.
`GitConfig`	`getGitConfig()` Optional.
`String`	`getId()` Output only.
`List<String>`	`getImages()` A list of images to be pushed upon the successful completion of all build steps.
`String`	`getLogsBucket()` Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
`String`	`getLogUrl()` Output only.
`String`	`getName()` Output only.
`BuildOptions`	`getOptions()` Special options for this build.
`String`	`getProjectId()` Output only.
`String`	`getQueueTtl()` TTL in queue for this build.
`Results`	`getResults()` Output only.
`List<Secret>`	`getSecrets()` Secrets to decrypt using Cloud Key Management Service.
`String`	`getServiceAccount()` IAM service account whose credentials will be used at build runtime.
`Source`	`getSource()` The location of the source files to build.
`SourceProvenance`	`getSourceProvenance()` Output only.
`String`	`getStartTime()` Output only.
`String`	`getStatus()` Output only.
`String`	`getStatusDetail()` Output only.
`List<BuildStep>`	`getSteps()` Required.
`Map<String,String>`	`getSubstitutions()` Substitutions data for `Build` resource.
`List<String>`	`getTags()` Tags for annotation of a `Build`.
`String`	`getTimeout()` Amount of time that this build should be allowed to run, to second granularity.
`Map<String,TimeSpan>`	`getTiming()` Output only.
`List<Warning>`	`getWarnings()` Output only.
`Build`	`set(String fieldName, Object value)`
`Build`	`setApproval(BuildApproval approval)` Output only.
`Build`	`setArtifacts(Artifacts artifacts)` Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
`Build`	`setAvailableSecrets(Secrets availableSecrets)` Secrets and secret environment variables.
`Build`	`setBuildTriggerId(String buildTriggerId)` Output only.
`Build`	`setCreateTime(String createTime)` Output only.
`Build`	`setFailureInfo(FailureInfo failureInfo)` Output only.
`Build`	`setFinishTime(String finishTime)` Output only.
`Build`	`setGitConfig(GitConfig gitConfig)` Optional.
`Build`	`setId(String id)` Output only.
`Build`	`setImages(List<String> images)` A list of images to be pushed upon the successful completion of all build steps.
`Build`	`setLogsBucket(String logsBucket)` Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
`Build`	`setLogUrl(String logUrl)` Output only.
`Build`	`setName(String name)` Output only.
`Build`	`setOptions(BuildOptions options)` Special options for this build.
`Build`	`setProjectId(String projectId)` Output only.
`Build`	`setQueueTtl(String queueTtl)` TTL in queue for this build.
`Build`	`setResults(Results results)` Output only.
`Build`	`setSecrets(List<Secret> secrets)` Secrets to decrypt using Cloud Key Management Service.
`Build`	`setServiceAccount(String serviceAccount)` IAM service account whose credentials will be used at build runtime.
`Build`	`setSource(Source source)` The location of the source files to build.
`Build`	`setSourceProvenance(SourceProvenance sourceProvenance)` Output only.
`Build`	`setStartTime(String startTime)` Output only.
`Build`	`setStatus(String status)` Output only.
`Build`	`setStatusDetail(String statusDetail)` Output only.
`Build`	`setSteps(List<BuildStep> steps)` Required.
`Build`	`setSubstitutions(Map<String,String> substitutions)` Substitutions data for `Build` resource.
`Build`	`setTags(List<String> tags)` Tags for annotation of a `Build`.
`Build`	`setTimeout(String timeout)` Amount of time that this build should be allowed to run, to second granularity.
`Build`	`setTiming(Map<String,TimeSpan> timing)` Output only.
`Build`	`setWarnings(List<Warning> warnings)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Build
```
public Build()
```
- Method Detail
  - getApproval
```
public BuildApproval getApproval()
```
    Output only. Describes this build's approval configuration, status, and result.
    
    Returns:
    
    value or null for none
  - setApproval
```
public Build setApproval(BuildApproval approval)
```
    Output only. Describes this build's approval configuration, status, and result.
    
    Parameters:
    
    approval - approval or null for none
  - getArtifacts
```
public Artifacts getArtifacts()
```
    Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
    
    Returns:
    
    value or null for none
  - setArtifacts
```
public Build setArtifacts(Artifacts artifacts)
```
    Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
    
    Parameters:
    
    artifacts - artifacts or null for none
  - getAvailableSecrets
```
public Secrets getAvailableSecrets()
```
    Secrets and secret environment variables.
    
    Returns:
    
    value or null for none
  - setAvailableSecrets
```
public Build setAvailableSecrets(Secrets availableSecrets)
```
    Secrets and secret environment variables.
    
    Parameters:
    
    availableSecrets - availableSecrets or null for none
  - getBuildTriggerId
```
public String getBuildTriggerId()
```
    Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.
    
    Returns:
    
    value or null for none
  - setBuildTriggerId
```
public Build setBuildTriggerId(String buildTriggerId)
```
    Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.
    
    Parameters:
    
    buildTriggerId - buildTriggerId or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Time at which the request to create the build was received.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Build setCreateTime(String createTime)
```
    Output only. Time at which the request to create the build was received.
    
    Parameters:
    
    createTime - createTime or null for none
  - getFailureInfo
```
public FailureInfo getFailureInfo()
```
    Output only. Contains information about the build when status=FAILURE.
    
    Returns:
    
    value or null for none
  - setFailureInfo
```
public Build setFailureInfo(FailureInfo failureInfo)
```
    Output only. Contains information about the build when status=FAILURE.
    
    Parameters:
    
    failureInfo - failureInfo or null for none
  - getFinishTime
```
public String getFinishTime()
```
    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.
    
    Returns:
    
    value or null for none
  - setFinishTime
```
public Build setFinishTime(String finishTime)
```
    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.
    
    Parameters:
    
    finishTime - finishTime or null for none
  - getGitConfig
```
public GitConfig getGitConfig()
```
    Optional. Configuration for git operations.
    
    Returns:
    
    value or null for none
  - setGitConfig
```
public Build setGitConfig(GitConfig gitConfig)
```
    Optional. Configuration for git operations.
    
    Parameters:
    
    gitConfig - gitConfig or null for none
  - getId
```
public String getId()
```
    Output only. Unique identifier of the build.
    
    Returns:
    
    value or null for none
  - setId
```
public Build setId(String id)
```
    Output only. Unique identifier of the build.
    
    Parameters:
    
    id - id or null for none
  - getImages
```
public List<String> getImages()
```
    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`.
    
    Returns:
    
    value or null for none
  - setImages
```
public Build setImages(List<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`.
    
    Parameters:
    
    images - images or null for none
  - getLogUrl
```
public String getLogUrl()
```
    Output only. URL to logs for this build in Google Cloud Console.
    
    Returns:
    
    value or null for none
  - setLogUrl
```
public Build setLogUrl(String logUrl)
```
    Output only. URL to logs for this build in Google Cloud Console.
    
    Parameters:
    
    logUrl - logUrl or null for none
  - getLogsBucket
```
public String getLogsBucket()
```
    Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
    
    Returns:
    
    value or null for none
  - setLogsBucket
```
public Build setLogsBucket(String logsBucket)
```
    Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
    
    Parameters:
    
    logsBucket - logsBucket or null for none
  - getName
```
public String getName()
```
    Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.
    
    Returns:
    
    value or null for none
  - setName
```
public Build setName(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.
    
    Parameters:
    
    name - name or null for none
  - getOptions
```
public BuildOptions getOptions()
```
    Special options for this build.
    
    Returns:
    
    value or null for none
  - setOptions
```
public Build setOptions(BuildOptions options)
```
    Special options for this build.
    
    Parameters:
    
    options - options or null for none
  - getProjectId
```
public String getProjectId()
```
    Output only. ID of the project.
    
    Returns:
    
    value or null for none
  - setProjectId
```
public Build setProjectId(String projectId)
```
    Output only. ID of the project.
    
    Parameters:
    
    projectId - projectId or null for none
  - getQueueTtl
```
public String getQueueTtl()
```
    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.
    
    Returns:
    
    value or null for none
  - setQueueTtl
```
public Build setQueueTtl(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.
    
    Parameters:
    
    queueTtl - queueTtl or null for none
  - getResults
```
public Results getResults()
```
    Output only. Results of the build.
    
    Returns:
    
    value or null for none
  - setResults
```
public Build setResults(Results results)
```
    Output only. Results of the build.
    
    Parameters:
    
    results - results or null for none
  - getSecrets
```
public List<Secret> getSecrets()
```
    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
    
    Returns:
    
    value or null for none
  - setSecrets
```
public Build setSecrets(List<Secret> 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
    
    Parameters:
    
    secrets - secrets or null for none
  - getServiceAccount
```
public String getServiceAccount()
```
    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.
    
    Returns:
    
    value or null for none
  - setServiceAccount
```
public Build setServiceAccount(String 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.
    
    Parameters:
    
    serviceAccount - serviceAccount or null for none
  - getSource
```
public Source getSource()
```
    The location of the source files to build.
    
    Returns:
    
    value or null for none
  - setSource
```
public Build setSource(Source source)
```
    The location of the source files to build.
    
    Parameters:
    
    source - source or null for none
  - getSourceProvenance
```
public SourceProvenance getSourceProvenance()
```
    Output only. A permanent fixed identifier for source.
    
    Returns:
    
    value or null for none
  - setSourceProvenance
```
public Build setSourceProvenance(SourceProvenance sourceProvenance)
```
    Output only. A permanent fixed identifier for source.
    
    Parameters:
    
    sourceProvenance - sourceProvenance or null for none
  - getStartTime
```
public String getStartTime()
```
    Output only. Time at which execution of the build was started.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public Build setStartTime(String startTime)
```
    Output only. Time at which execution of the build was started.
    
    Parameters:
    
    startTime - startTime or null for none
  - getStatus
```
public String getStatus()
```
    Output only. Status of the build.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Build setStatus(String status)
```
    Output only. Status of the build.
    
    Parameters:
    
    status - status or null for none
  - getStatusDetail
```
public String getStatusDetail()
```
    Output only. Customer-readable message about the current status.
    
    Returns:
    
    value or null for none
  - setStatusDetail
```
public Build setStatusDetail(String statusDetail)
```
    Output only. Customer-readable message about the current status.
    
    Parameters:
    
    statusDetail - statusDetail or null for none
  - getSteps
```
public List<BuildStep> getSteps()
```
    Required. The operations to be performed on the workspace.
    
    Returns:
    
    value or null for none
  - setSteps
```
public Build setSteps(List<BuildStep> steps)
```
    Required. The operations to be performed on the workspace.
    
    Parameters:
    
    steps - steps or null for none
  - getSubstitutions
```
public Map<String,String> getSubstitutions()
```
    Substitutions data for `Build` resource.
    
    Returns:
    
    value or null for none
  - setSubstitutions
```
public Build setSubstitutions(Map<String,String> substitutions)
```
    Substitutions data for `Build` resource.
    
    Parameters:
    
    substitutions - substitutions or null for none
  - getTags
```
public List<String> getTags()
```
    Tags for annotation of a `Build`. These are not docker tags.
    
    Returns:
    
    value or null for none
  - setTags
```
public Build setTags(List<String> tags)
```
    Tags for annotation of a `Build`. These are not docker tags.
    
    Parameters:
    
    tags - tags or null for none
  - getTimeout
```
public String getTimeout()
```
    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.
    
    Returns:
    
    value or null for none
  - setTimeout
```
public Build setTimeout(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.
    
    Parameters:
    
    timeout - timeout or null for none
  - getTiming
```
public Map<String,TimeSpan> getTiming()
```
    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.
    
    Returns:
    
    value or null for none
  - setTiming
```
public Build setTiming(Map<String,TimeSpan> 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.
    
    Parameters:
    
    timing - timing or null for none
  - getWarnings
```
public List<Warning> getWarnings()
```
    Output only. Non-fatal problems encountered during the execution of the build.
    
    Returns:
    
    value or null for none
  - setWarnings
```
public Build setWarnings(List<Warning> warnings)
```
    Output only. Non-fatal problems encountered during the execution of the build.
    
    Parameters:
    
    warnings - warnings or null for none
  - set
```
public Build set(String fieldName,
                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Build clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Build

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Build

Method Detail

getApproval

setApproval

getArtifacts

setArtifacts

getAvailableSecrets

setAvailableSecrets

getBuildTriggerId

setBuildTriggerId

getCreateTime

setCreateTime

getFailureInfo

setFailureInfo

getFinishTime

setFinishTime

getGitConfig

setGitConfig

getId

setId

getImages

setImages

getLogUrl

setLogUrl

getLogsBucket

setLogsBucket

getName

setName

getOptions

setOptions

getProjectId

setProjectId

getQueueTtl

setQueueTtl

getResults

setResults

getSecrets

setSecrets

getServiceAccount

setServiceAccount

getSource

setSource

getSourceProvenance

setSourceProvenance

getStartTime

setStartTime

getStatus

setStatus

getStatusDetail

setStatusDetail

getSteps

setSteps

getSubstitutions

setSubstitutions

getTags

setTags

getTimeout

setTimeout

getTiming

setTiming

getWarnings

setWarnings

set

clone