Interface BuildEventDataOrBuilder (0.16.0) 

public interface BuildEventDataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsSubstitutions(String key)

public abstract 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 abstract boolean containsTiming(String key)

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. If the build does not specify source or images, these keys will not be included.

map<string, .google.events.cloud.cloudbuild.v1.TimeSpan> timing = 33;

Parameter
Name Description
key String
Returns
Type Description
boolean

getArtifacts()

public abstract Artifacts getArtifacts()

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

.google.events.cloud.cloudbuild.v1.Artifacts artifacts = 37;

Returns
Type Description
Artifacts

The artifacts.

getArtifactsOrBuilder()

public abstract ArtifactsOrBuilder getArtifactsOrBuilder()

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

.google.events.cloud.cloudbuild.v1.Artifacts artifacts = 37;

Returns
Type Description
ArtifactsOrBuilder

getBuildTriggerId()

public abstract String getBuildTriggerId()

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

string build_trigger_id = 22;

Returns
Type Description
String

The buildTriggerId.

getBuildTriggerIdBytes()

public abstract ByteString getBuildTriggerIdBytes()

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

string build_trigger_id = 22;

Returns
Type Description
ByteString

The bytes for buildTriggerId.

getCreateTime()

public abstract Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
TimestampOrBuilder

getFinishTime()

public abstract Timestamp getFinishTime()

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;

Returns
Type Description
Timestamp

The finishTime.

getFinishTimeOrBuilder()

public abstract TimestampOrBuilder getFinishTimeOrBuilder()

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;

Returns
Type Description
TimestampOrBuilder

getId()

public abstract String getId()

Unique identifier of the build.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public abstract ByteString getIdBytes()

Unique identifier of the build.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getImages(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the images.

getLogUrl()

public abstract String getLogUrl()

URL to logs for this build in Google Cloud Console.

string log_url = 25;

Returns
Type Description
String

The logUrl.

getLogUrlBytes()

public abstract ByteString getLogUrlBytes()

URL to logs for this build in Google Cloud Console.

string log_url = 25;

Returns
Type Description
ByteString

The bytes for logUrl.

getLogsBucket()

public abstract String getLogsBucket()

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;

Returns
Type Description
String

The logsBucket.

getLogsBucketBytes()

public abstract ByteString getLogsBucketBytes()

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;

Returns
Type Description
ByteString

The bytes for logsBucket.

getOptions()

public abstract BuildOptions getOptions()

Special options for this build.

.google.events.cloud.cloudbuild.v1.BuildOptions options = 23;

Returns
Type Description
BuildOptions

The options.

getOptionsOrBuilder()

public abstract BuildOptionsOrBuilder getOptionsOrBuilder()

Special options for this build.

.google.events.cloud.cloudbuild.v1.BuildOptions options = 23;

Returns
Type Description
BuildOptionsOrBuilder

getProjectId()

public abstract String getProjectId()

ID of the project.

string project_id = 16;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

ID of the project.

string project_id = 16;

Returns
Type Description
ByteString

The bytes for projectId.

getQueueTtl()

public abstract 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 abstract 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 abstract Results getResults()

Results of the build.

.google.events.cloud.cloudbuild.v1.Results results = 10;

Returns
Type Description
Results

The results.

getResultsOrBuilder()

public abstract ResultsOrBuilder getResultsOrBuilder()

Results of the build.

.google.events.cloud.cloudbuild.v1.Results results = 10;

Returns
Type Description
ResultsOrBuilder

getSecrets(int index)

public abstract Secret getSecrets(int index)

Secrets to decrypt using Cloud Key Management Service.

repeated .google.events.cloud.cloudbuild.v1.Secret secrets = 32;

Parameter
Name Description
index int
Returns
Type Description
Secret

getSecretsCount()

public abstract int getSecretsCount()

Secrets to decrypt using Cloud Key Management Service.

repeated .google.events.cloud.cloudbuild.v1.Secret secrets = 32;

Returns
Type Description
int

getSecretsList()

public abstract List<Secret> getSecretsList()

Secrets to decrypt using Cloud Key Management Service.

repeated .google.events.cloud.cloudbuild.v1.Secret secrets = 32;

Returns
Type Description
List<Secret>

getSecretsOrBuilder(int index)

public abstract SecretOrBuilder getSecretsOrBuilder(int index)

Secrets to decrypt using Cloud Key Management Service.

repeated .google.events.cloud.cloudbuild.v1.Secret secrets = 32;

Parameter
Name Description
index int
Returns
Type Description
SecretOrBuilder

getSecretsOrBuilderList()

public abstract List<? extends SecretOrBuilder> getSecretsOrBuilderList()

Secrets to decrypt using Cloud Key Management Service.

repeated .google.events.cloud.cloudbuild.v1.Secret secrets = 32;

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

getSource()

public abstract Source getSource()

The location of the source files to build.

.google.events.cloud.cloudbuild.v1.Source source = 3;

Returns
Type Description
Source

The source.

getSourceOrBuilder()

public abstract SourceOrBuilder getSourceOrBuilder()

The location of the source files to build.

.google.events.cloud.cloudbuild.v1.Source source = 3;

Returns
Type Description
SourceOrBuilder

getSourceProvenance()

public abstract SourceProvenance getSourceProvenance()

A permanent fixed identifier for source.

.google.events.cloud.cloudbuild.v1.SourceProvenance source_provenance = 21;

Returns
Type Description
SourceProvenance

The sourceProvenance.

getSourceProvenanceOrBuilder()

public abstract SourceProvenanceOrBuilder getSourceProvenanceOrBuilder()

A permanent fixed identifier for source.

.google.events.cloud.cloudbuild.v1.SourceProvenance source_provenance = 21;

Returns
Type Description
SourceProvenanceOrBuilder

getStartTime()

public abstract Timestamp getStartTime()

Time at which execution of the build was started.

.google.protobuf.Timestamp start_time = 7;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Time at which execution of the build was started.

.google.protobuf.Timestamp start_time = 7;

Returns
Type Description
TimestampOrBuilder

getStatus()

public abstract BuildEventData.Status getStatus()

Status of the build.

.google.events.cloud.cloudbuild.v1.BuildEventData.Status status = 2;

Returns
Type Description
BuildEventData.Status

The status.

getStatusDetail()

public abstract String getStatusDetail()

Customer-readable message about the current status.

string status_detail = 24;

Returns
Type Description
String

The statusDetail.

getStatusDetailBytes()

public abstract ByteString getStatusDetailBytes()

Customer-readable message about the current status.

string status_detail = 24;

Returns
Type Description
ByteString

The bytes for statusDetail.

getStatusValue()

public abstract int getStatusValue()

Status of the build.

.google.events.cloud.cloudbuild.v1.BuildEventData.Status status = 2;

Returns
Type Description
int

The enum numeric value on the wire for status.

getSteps(int index)

public abstract BuildStep getSteps(int index)

The operations to be performed on the workspace.

repeated .google.events.cloud.cloudbuild.v1.BuildStep steps = 11;

Parameter
Name Description
index int
Returns
Type Description
BuildStep

getStepsCount()

public abstract int getStepsCount()

The operations to be performed on the workspace.

repeated .google.events.cloud.cloudbuild.v1.BuildStep steps = 11;

Returns
Type Description
int

getStepsList()

public abstract List<BuildStep> getStepsList()

The operations to be performed on the workspace.

repeated .google.events.cloud.cloudbuild.v1.BuildStep steps = 11;

Returns
Type Description
List<BuildStep>

getStepsOrBuilder(int index)

public abstract BuildStepOrBuilder getStepsOrBuilder(int index)

The operations to be performed on the workspace.

repeated .google.events.cloud.cloudbuild.v1.BuildStep steps = 11;

Parameter
Name Description
index int
Returns
Type Description
BuildStepOrBuilder

getStepsOrBuilderList()

public abstract List<? extends BuildStepOrBuilder> getStepsOrBuilderList()

The operations to be performed on the workspace.

repeated .google.events.cloud.cloudbuild.v1.BuildStep steps = 11;

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

getSubstitutions()

public abstract Map<String,String> getSubstitutions()

Use #getSubstitutionsMap() instead.

Returns
Type Description
Map<String,String>

getSubstitutionsCount()

public abstract int getSubstitutionsCount()

Substitutions data for Build resource.

map<string, string> substitutions = 29;

Returns
Type Description
int

getSubstitutionsMap()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> getTagsList()

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

repeated string tags = 31;

Returns
Type Description
List<String>

A list containing the tags.

getTimeout()

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

.google.protobuf.Duration timeout = 12;

Returns
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 12;

Returns
Type Description
DurationOrBuilder

getTiming()

public abstract Map<String,TimeSpan> getTiming()

Use #getTimingMap() instead.

Returns
Type Description
Map<String,TimeSpan>

getTimingCount()

public abstract int getTimingCount()

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. If the build does not specify source or images, these keys will not be included.

map<string, .google.events.cloud.cloudbuild.v1.TimeSpan> timing = 33;

Returns
Type Description
int

getTimingMap()

public abstract Map<String,TimeSpan> getTimingMap()

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. If the build does not specify source or images, these keys will not be included.

map<string, .google.events.cloud.cloudbuild.v1.TimeSpan> timing = 33;

Returns
Type Description
Map<String,TimeSpan>

getTimingOrDefault(String key, TimeSpan defaultValue)

public abstract TimeSpan getTimingOrDefault(String key, TimeSpan defaultValue)

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. If the build does not specify source or images, these keys will not be included.

map<string, .google.events.cloud.cloudbuild.v1.TimeSpan> timing = 33;

Parameters
Name Description
key String
defaultValue TimeSpan
Returns
Type Description
TimeSpan

getTimingOrThrow(String key)

public abstract TimeSpan getTimingOrThrow(String key)

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. If the build does not specify source or images, these keys will not be included.

map<string, .google.events.cloud.cloudbuild.v1.TimeSpan> timing = 33;

Parameter
Name Description
key String
Returns
Type Description
TimeSpan

hasArtifacts()

public abstract boolean hasArtifacts()

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

.google.events.cloud.cloudbuild.v1.Artifacts artifacts = 37;

Returns
Type Description
boolean

Whether the artifacts field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
boolean

Whether the createTime field is set.

hasFinishTime()

public abstract boolean hasFinishTime()

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;

Returns
Type Description
boolean

Whether the finishTime field is set.

hasOptions()

public abstract boolean hasOptions()

Special options for this build.

.google.events.cloud.cloudbuild.v1.BuildOptions options = 23;

Returns
Type Description
boolean

Whether the options field is set.

hasQueueTtl()

public abstract 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 abstract boolean hasResults()

Results of the build.

.google.events.cloud.cloudbuild.v1.Results results = 10;

Returns
Type Description
boolean

Whether the results field is set.

hasSource()

public abstract boolean hasSource()

The location of the source files to build.

.google.events.cloud.cloudbuild.v1.Source source = 3;

Returns
Type Description
boolean

Whether the source field is set.

hasSourceProvenance()

public abstract boolean hasSourceProvenance()

A permanent fixed identifier for source.

.google.events.cloud.cloudbuild.v1.SourceProvenance source_provenance = 21;

Returns
Type Description
boolean

Whether the sourceProvenance field is set.

hasStartTime()

public abstract boolean hasStartTime()

Time at which execution of the build was started.

.google.protobuf.Timestamp start_time = 7;

Returns
Type Description
boolean

Whether the startTime field is set.

hasTimeout()

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

.google.protobuf.Duration timeout = 12;

Returns
Type Description
boolean

Whether the timeout field is set.