Class Build (3.55.0) 

public final class Build extends GeneratedMessageV3 implements BuildOrBuilder

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.

Protobuf type google.devtools.cloudbuild.v1.Build

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Build

Implements

BuildOrBuilder

Static Fields

APPROVAL_FIELD_NUMBER

public static final int APPROVAL_FIELD_NUMBER
Field Value
Type Description
int

ARTIFACTS_FIELD_NUMBER

public static final int ARTIFACTS_FIELD_NUMBER
Field Value
Type Description
int

AVAILABLE_SECRETS_FIELD_NUMBER

public static final int AVAILABLE_SECRETS_FIELD_NUMBER
Field Value
Type Description
int

BUILD_TRIGGER_ID_FIELD_NUMBER

public static final int BUILD_TRIGGER_ID_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_INFO_FIELD_NUMBER

public static final int FAILURE_INFO_FIELD_NUMBER
Field Value
Type Description
int

FINISH_TIME_FIELD_NUMBER

public static final int FINISH_TIME_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

IMAGES_FIELD_NUMBER

public static final int IMAGES_FIELD_NUMBER
Field Value
Type Description
int

LOGS_BUCKET_FIELD_NUMBER

public static final int LOGS_BUCKET_FIELD_NUMBER
Field Value
Type Description
int

LOG_URL_FIELD_NUMBER

public static final int LOG_URL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

QUEUE_TTL_FIELD_NUMBER

public static final int QUEUE_TTL_FIELD_NUMBER
Field Value
Type Description
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
Type Description
int

SECRETS_FIELD_NUMBER

public static final int SECRETS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_PROVENANCE_FIELD_NUMBER

public static final int SOURCE_PROVENANCE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_DETAIL_FIELD_NUMBER

public static final int STATUS_DETAIL_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

STEPS_FIELD_NUMBER

public static final int STEPS_FIELD_NUMBER
Field Value
Type Description
int

SUBSTITUTIONS_FIELD_NUMBER

public static final int SUBSTITUTIONS_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

TIMING_FIELD_NUMBER

public static final int TIMING_FIELD_NUMBER
Field Value
Type Description
int

WARNINGS_FIELD_NUMBER

public static final int WARNINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Build getDefaultInstance()
Returns
Type Description
Build

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Build.Builder newBuilder()
Returns
Type Description
Build.Builder

newBuilder(Build prototype)

public static Build.Builder newBuilder(Build prototype)
Parameter
Name Description
prototype Build
Returns
Type Description
Build.Builder

parseDelimitedFrom(InputStream input)

public static Build parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Build
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Build parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Build
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Build parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Build
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Build parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Build
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Build parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Build
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Build parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Build
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Build parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Build
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Build parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Build
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Build parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Build
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Build parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Build
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Build parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Build
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Build parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Build
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Build> parser()
Returns
Type Description
Parser<Build>

Methods

containsSubstitutions(String key)

public boolean containsSubstitutions(String key)

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsTiming(String key)

public boolean containsTiming(String key)

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.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApproval()

public BuildApproval getApproval()

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

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

Returns
Type Description
BuildApproval

The approval.

getApprovalOrBuilder()

public BuildApprovalOrBuilder getApprovalOrBuilder()

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

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

Returns
Type Description
BuildApprovalOrBuilder

getArtifacts()

public Artifacts getArtifacts()

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

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

Returns
Type Description
Artifacts

The artifacts.

getArtifactsOrBuilder()

public ArtifactsOrBuilder getArtifactsOrBuilder()

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

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

Returns
Type Description
ArtifactsOrBuilder

getAvailableSecrets()

public Secrets getAvailableSecrets()

Secrets and secret environment variables.

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

Returns
Type Description
Secrets

The availableSecrets.

getAvailableSecretsOrBuilder()

public SecretsOrBuilder getAvailableSecretsOrBuilder()

Secrets and secret environment variables.

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

Returns
Type Description
SecretsOrBuilder

getBuildTriggerId()

public String getBuildTriggerId()

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];

Returns
Type Description
String

The buildTriggerId.

getBuildTriggerIdBytes()

public ByteString getBuildTriggerIdBytes()

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];

Returns
Type Description
ByteString

The bytes for buildTriggerId.

getCreateTime()

public Timestamp getCreateTime()

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];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Build getDefaultInstanceForType()
Returns
Type Description
Build

getFailureInfo()

public Build.FailureInfo getFailureInfo()

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];

Returns
Type Description
Build.FailureInfo

The failureInfo.

getFailureInfoOrBuilder()

public Build.FailureInfoOrBuilder getFailureInfoOrBuilder()

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];

Returns
Type Description
Build.FailureInfoOrBuilder

getFinishTime()

public Timestamp 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.

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

Returns
Type Description
Timestamp

The finishTime.

getFinishTimeOrBuilder()

public TimestampOrBuilder getFinishTimeOrBuilder()

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];

Returns
Type Description
TimestampOrBuilder

getId()

public String getId()

Output only. Unique identifier of the build.

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

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Output only. Unique identifier of the build.

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

Returns
Type Description
ByteString

The bytes for id.

getImages(int index)

public String getImages(int index)

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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The images at the given index.

getImagesBytes(int index)

public ByteString getImagesBytes(int index)

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;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the images at the given index.

getImagesCount()

public int getImagesCount()

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;

Returns
Type Description
int

The count of images.

getImagesList()

public ProtocolStringList getImagesList()

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;

Returns
Type Description
ProtocolStringList

A list containing the images.

getLogUrl()

public String getLogUrl()

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

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

Returns
Type Description
String

The logUrl.

getLogUrlBytes()

public ByteString getLogUrlBytes()

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

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

Returns
Type Description
ByteString

The bytes for logUrl.

getLogsBucket()

public String getLogsBucket()

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;

Returns
Type Description
String

The logsBucket.

getLogsBucketBytes()

public ByteString getLogsBucketBytes()

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;

Returns
Type Description
ByteString

The bytes for logsBucket.

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.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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];

Returns
Type Description
ByteString

The bytes for name.

getOptions()

public BuildOptions getOptions()

Special options for this build.

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

Returns
Type Description
BuildOptions

The options.

getOptionsOrBuilder()

public BuildOptionsOrBuilder getOptionsOrBuilder()

Special options for this build.

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

Returns
Type Description
BuildOptionsOrBuilder

getParserForType()

public Parser<Build> getParserForType()
Returns
Type Description
Parser<Build>
Overrides

getProjectId()

public String getProjectId()

Output only. ID of the project.

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

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Output only. ID of the project.

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

Returns
Type Description
ByteString

The bytes for projectId.

getQueueTtl()

public Duration 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.

.google.protobuf.Duration queue_ttl = 40;

Returns
Type Description
Duration

The queueTtl.

getQueueTtlOrBuilder()

public DurationOrBuilder getQueueTtlOrBuilder()

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;

Returns
Type Description
DurationOrBuilder

getResults()

public Results getResults()

Output only. Results of the build.

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

Returns
Type Description
Results

The results.

getResultsOrBuilder()

public ResultsOrBuilder getResultsOrBuilder()

Output only. Results of the build.

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

Returns
Type Description
ResultsOrBuilder

getSecrets(int index)

public Secret getSecrets(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
Secret

getSecretsCount()

public int getSecretsCount()

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;

Returns
Type Description
int

getSecretsList()

public List<Secret> getSecretsList()

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;

Returns
Type Description
List<Secret>

getSecretsOrBuilder(int index)

public SecretOrBuilder getSecretsOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
SecretOrBuilder

getSecretsOrBuilderList()

public List<? extends SecretOrBuilder> getSecretsOrBuilderList()

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;

Returns
Type Description
List<? extends com.google.cloudbuild.v1.SecretOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

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) = { ... }

Returns
Type Description
ByteString

The bytes for serviceAccount.

getSource()

public Source getSource()

The location of the source files to build.

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

Returns
Type Description
Source

The source.

getSourceOrBuilder()

public SourceOrBuilder getSourceOrBuilder()

The location of the source files to build.

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

Returns
Type Description
SourceOrBuilder

getSourceProvenance()

public SourceProvenance getSourceProvenance()

Output only. A permanent fixed identifier for source.

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

Returns
Type Description
SourceProvenance

The sourceProvenance.

getSourceProvenanceOrBuilder()

public SourceProvenanceOrBuilder getSourceProvenanceOrBuilder()

Output only. A permanent fixed identifier for source.

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

Returns
Type Description
SourceProvenanceOrBuilder

getStartTime()

public Timestamp getStartTime()

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

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

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getStatus()

public Build.Status getStatus()

Output only. Status of the build.

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

Returns
Type Description
Build.Status

The status.

getStatusDetail()

public String getStatusDetail()

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

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

Returns
Type Description
String

The statusDetail.

getStatusDetailBytes()

public ByteString getStatusDetailBytes()

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

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

Returns
Type Description
ByteString

The bytes for statusDetail.

getStatusValue()

public int getStatusValue()

Output only. Status of the build.

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

Returns
Type Description
int

The enum numeric value on the wire for status.

getSteps(int index)

public BuildStep getSteps(int index)

Required. The operations to be performed on the workspace.

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

Parameter
Name Description
index int
Returns
Type Description
BuildStep

getStepsCount()

public int getStepsCount()

Required. The operations to be performed on the workspace.

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

Returns
Type Description
int

getStepsList()

public List<BuildStep> getStepsList()

Required. The operations to be performed on the workspace.

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

Returns
Type Description
List<BuildStep>

getStepsOrBuilder(int index)

public BuildStepOrBuilder getStepsOrBuilder(int index)

Required. The operations to be performed on the workspace.

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

Parameter
Name Description
index int
Returns
Type Description
BuildStepOrBuilder

getStepsOrBuilderList()

public List<? extends BuildStepOrBuilder> getStepsOrBuilderList()

Required. The operations to be performed on the workspace.

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

Returns
Type Description
List<? extends com.google.cloudbuild.v1.BuildStepOrBuilder>

getSubstitutions() (deprecated)

public Map<String,String> getSubstitutions()

Use #getSubstitutionsMap() instead.

Returns
Type Description
Map<String,String>

getSubstitutionsCount()

public int getSubstitutionsCount()

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Returns
Type Description
int

getSubstitutionsMap()

public Map<String,String> getSubstitutionsMap()

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Returns
Type Description
Map<String,String>

getSubstitutionsOrDefault(String key, String defaultValue)

public String getSubstitutionsOrDefault(String key, String defaultValue)

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getSubstitutionsOrThrow(String key)

public String getSubstitutionsOrThrow(String key)

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Parameter
Name Description
key String
Returns
Type Description
String

getTags(int index)

public String getTags(int index)

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

repeated string tags = 31;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

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

repeated string tags = 31;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

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

repeated string tags = 31;

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

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

repeated string tags = 31;

Returns
Type Description
ProtocolStringList

A list containing the tags.

getTimeout()

public Duration 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.

.google.protobuf.Duration timeout = 12;

Returns
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

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.

.google.protobuf.Duration timeout = 12;

Returns
Type Description
DurationOrBuilder

getTiming() (deprecated)

public Map<String,TimeSpan> getTiming()

Use #getTimingMap() instead.

Returns
Type Description
Map<String,TimeSpan>

getTimingCount()

public int getTimingCount()

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.

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

Returns
Type Description
int

getTimingMap()

public Map<String,TimeSpan> getTimingMap()

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.

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

Returns
Type Description
Map<String,TimeSpan>

getTimingOrDefault(String key, TimeSpan defaultValue)

public TimeSpan getTimingOrDefault(String key, TimeSpan defaultValue)

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.

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

Parameters
Name Description
key String
defaultValue TimeSpan
Returns
Type Description
TimeSpan

getTimingOrThrow(String key)

public TimeSpan getTimingOrThrow(String key)

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.

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

Parameter
Name Description
key String
Returns
Type Description
TimeSpan

getWarnings(int index)

public Build.Warning getWarnings(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Build.Warning

getWarningsCount()

public int getWarningsCount()

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];

Returns
Type Description
int

getWarningsList()

public List<Build.Warning> getWarningsList()

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];

Returns
Type Description
List<Warning>

getWarningsOrBuilder(int index)

public Build.WarningOrBuilder getWarningsOrBuilder(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Build.WarningOrBuilder

getWarningsOrBuilderList()

public List<? extends Build.WarningOrBuilder> getWarningsOrBuilderList()

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];

Returns
Type Description
List<? extends com.google.cloudbuild.v1.Build.WarningOrBuilder>

hasApproval()

public boolean hasApproval()

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

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

Returns
Type Description
boolean

Whether the approval field is set.

hasArtifacts()

public boolean hasArtifacts()

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

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

Returns
Type Description
boolean

Whether the artifacts field is set.

hasAvailableSecrets()

public boolean hasAvailableSecrets()

Secrets and secret environment variables.

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

Returns
Type Description
boolean

Whether the availableSecrets field is set.

hasCreateTime()

public boolean hasCreateTime()

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];

Returns
Type Description
boolean

Whether the createTime field is set.

hasFailureInfo()

public boolean hasFailureInfo()

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];

Returns
Type Description
boolean

Whether the failureInfo field is set.

hasFinishTime()

public boolean hasFinishTime()

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];

Returns
Type Description
boolean

Whether the finishTime field is set.

hasOptions()

public boolean hasOptions()

Special options for this build.

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

Returns
Type Description
boolean

Whether the options field is set.

hasQueueTtl()

public boolean hasQueueTtl()

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;

Returns
Type Description
boolean

Whether the queueTtl field is set.

hasResults()

public boolean hasResults()

Output only. Results of the build.

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

Returns
Type Description
boolean

Whether the results field is set.

hasSource()

public boolean hasSource()

The location of the source files to build.

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

Returns
Type Description
boolean

Whether the source field is set.

hasSourceProvenance()

public boolean hasSourceProvenance()

Output only. A permanent fixed identifier for source.

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

Returns
Type Description
boolean

Whether the sourceProvenance field is set.

hasStartTime()

public boolean hasStartTime()

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

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

Returns
Type Description
boolean

Whether the startTime field is set.

hasTimeout()

public boolean hasTimeout()

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.

.google.protobuf.Duration timeout = 12;

Returns
Type Description
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Build.Builder newBuilderForType()
Returns
Type Description
Build.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Build.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Build.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Build.Builder toBuilder()
Returns
Type Description
Build.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException