Class BuildStep.Builder (3.8.0)

public static final class BuildStep.Builder extends GeneratedMessageV3.Builder<BuildStep.Builder> implements BuildStepOrBuilder

A step in the build pipeline.

Protobuf type google.devtools.cloudbuild.v1.BuildStep

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BuildStep.Builder

Implements

BuildStepOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllAllowExitCodes(Iterable<? extends Integer> values)

public BuildStep.Builder addAllAllowExitCodes(Iterable<? extends Integer> values)

Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.

repeated int32 allow_exit_codes = 18;

Parameter

Name	Description
values	`Iterable<? extends java.lang.Integer>` The allowExitCodes to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addAllArgs(Iterable<String> values)

public BuildStep.Builder addAllArgs(Iterable<String> values)

A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.

repeated string args = 3;

Parameter

Name	Description
values	`Iterable<String>` The args to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addAllEnv(Iterable<String> values)

public BuildStep.Builder addAllEnv(Iterable<String> values)

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Parameter

Name	Description
values	`Iterable<String>` The env to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addAllSecretEnv(Iterable<String> values)

public BuildStep.Builder addAllSecretEnv(Iterable<String> values)

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Parameter

Name	Description
values	`Iterable<String>` The secretEnv to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addAllVolumes(Iterable<? extends Volume> values)

public BuildStep.Builder addAllVolumes(Iterable<? extends Volume> values)

List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameter

Name	Description
values	`Iterable<? extends com.google.cloudbuild.v1.Volume>`

Returns

Type	Description
BuildStep.Builder

addAllWaitFor(Iterable<String> values)

public BuildStep.Builder addAllWaitFor(Iterable<String> values)

The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

repeated string wait_for = 6;

Parameter

Name	Description
values	`Iterable<String>` The waitFor to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addAllowExitCodes(int value)

public BuildStep.Builder addAllowExitCodes(int value)

Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.

repeated int32 allow_exit_codes = 18;

Parameter

Name	Description
value	`int` The allowExitCodes to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addArgs(String value)

public BuildStep.Builder addArgs(String value)

repeated string args = 3;

Parameter

Name	Description
value	`String` The args to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addArgsBytes(ByteString value)

public BuildStep.Builder addArgsBytes(ByteString value)

repeated string args = 3;

Parameter

Name	Description
value	`ByteString` The bytes of the args to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addEnv(String value)

public BuildStep.Builder addEnv(String value)

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Parameter

Name	Description
value	`String` The env to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addEnvBytes(ByteString value)

public BuildStep.Builder addEnvBytes(ByteString value)

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Parameter

Name	Description
value	`ByteString` The bytes of the env to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BuildStep.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSecretEnv(String value)

public BuildStep.Builder addSecretEnv(String value)

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Parameter

Name	Description
value	`String` The secretEnv to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addSecretEnvBytes(ByteString value)

public BuildStep.Builder addSecretEnvBytes(ByteString value)

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Parameter

Name	Description
value	`ByteString` The bytes of the secretEnv to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addVolumes(Volume value)

public BuildStep.Builder addVolumes(Volume value)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameter

Name	Description
value	`Volume`

Returns

Type	Description
BuildStep.Builder

addVolumes(Volume.Builder builderForValue)

public BuildStep.Builder addVolumes(Volume.Builder builderForValue)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameter

Name	Description
builderForValue	`Volume.Builder`

Returns

Type	Description
BuildStep.Builder

addVolumes(int index, Volume value)

public BuildStep.Builder addVolumes(int index, Volume value)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameters

Name	Description
index	`int`
value	`Volume`

Returns

Type	Description
BuildStep.Builder

addVolumes(int index, Volume.Builder builderForValue)

public BuildStep.Builder addVolumes(int index, Volume.Builder builderForValue)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameters

Name	Description
index	`int`
builderForValue	`Volume.Builder`

Returns

Type	Description
BuildStep.Builder

addVolumesBuilder()

public Volume.Builder addVolumesBuilder()

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Returns

Type	Description
Volume.Builder

addVolumesBuilder(int index)

public Volume.Builder addVolumesBuilder(int index)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Volume.Builder

addWaitFor(String value)

public BuildStep.Builder addWaitFor(String value)

repeated string wait_for = 6;

Parameter

Name	Description
value	`String` The waitFor to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

addWaitForBytes(ByteString value)

public BuildStep.Builder addWaitForBytes(ByteString value)

repeated string wait_for = 6;

Parameter

Name	Description
value	`ByteString` The bytes of the waitFor to add.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

build()

public BuildStep build()

Returns

Type	Description
BuildStep

buildPartial()

public BuildStep buildPartial()

Returns

Type	Description
BuildStep

clear()

public BuildStep.Builder clear()

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAllowExitCodes()

public BuildStep.Builder clearAllowExitCodes()

Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.

repeated int32 allow_exit_codes = 18;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearAllowFailure()

public BuildStep.Builder clearAllowFailure()

Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.

bool allow_failure = 14;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearArgs()

public BuildStep.Builder clearArgs()

repeated string args = 3;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearDir()

public BuildStep.Builder clearDir()

Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step's execution.

string dir = 4;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearEntrypoint()

public BuildStep.Builder clearEntrypoint()

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

string entrypoint = 7;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearEnv()

public BuildStep.Builder clearEnv()

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearExitCode()

public BuildStep.Builder clearExitCode()

Output only. Return code from running the step.

int32 exit_code = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BuildStep.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearId()

public BuildStep.Builder clearId()

Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

string id = 5;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearName()

public BuildStep.Builder clearName()

Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.

string name = 1;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BuildStep.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPullTiming()

public BuildStep.Builder clearPullTiming()

Output only. Stores timing information for pulling this build step's builder image only.

.google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
BuildStep.Builder

clearScript()

public BuildStep.Builder clearScript()

A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.

string script = 19;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearSecretEnv()

public BuildStep.Builder clearSecretEnv()

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearStatus()

public BuildStep.Builder clearStatus()

Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.

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

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clearTimeout()

public BuildStep.Builder clearTimeout()

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

.google.protobuf.Duration timeout = 11;

Returns

Type	Description
BuildStep.Builder

clearTiming()

public BuildStep.Builder clearTiming()

Output only. Stores timing information for executing this build step.

.google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
BuildStep.Builder

clearVolumes()

public BuildStep.Builder clearVolumes()

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Returns

Type	Description
BuildStep.Builder

clearWaitFor()

public BuildStep.Builder clearWaitFor()

repeated string wait_for = 6;

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

clone()

public BuildStep.Builder clone()

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAllowExitCodes(int index)

public int getAllowExitCodes(int index)

Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.

repeated int32 allow_exit_codes = 18;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
int	The allowExitCodes at the given index.

getAllowExitCodesCount()

public int getAllowExitCodesCount()

Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.

repeated int32 allow_exit_codes = 18;

Returns

Type	Description
int	The count of allowExitCodes.

getAllowExitCodesList()

public List<Integer> getAllowExitCodesList()

Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.

repeated int32 allow_exit_codes = 18;

Returns

Type	Description
List<Integer>	A list containing the allowExitCodes.

getAllowFailure()

public boolean getAllowFailure()

bool allow_failure = 14;

Returns

Type	Description
boolean	The allowFailure.

getArgs(int index)

public String getArgs(int index)

repeated string args = 3;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The args at the given index.

getArgsBytes(int index)

public ByteString getArgsBytes(int index)

repeated string args = 3;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the args at the given index.

getArgsCount()

public int getArgsCount()

repeated string args = 3;

Returns

Type	Description
int	The count of args.

getArgsList()

public ProtocolStringList getArgsList()

repeated string args = 3;

Returns

Type	Description
ProtocolStringList	A list containing the args.

getDefaultInstanceForType()

public BuildStep getDefaultInstanceForType()

Returns

Type	Description
BuildStep

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDir()

public String getDir()

string dir = 4;

Returns

Type	Description
String	The dir.

getDirBytes()

public ByteString getDirBytes()

string dir = 4;

Returns

Type	Description
ByteString	The bytes for dir.

getEntrypoint()

public String getEntrypoint()

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

string entrypoint = 7;

Returns

Type	Description
String	The entrypoint.

getEntrypointBytes()

public ByteString getEntrypointBytes()

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

string entrypoint = 7;

Returns

Type	Description
ByteString	The bytes for entrypoint.

getEnv(int index)

public String getEnv(int index)

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The env at the given index.

getEnvBytes(int index)

public ByteString getEnvBytes(int index)

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the env at the given index.

getEnvCount()

public int getEnvCount()

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Returns

Type	Description
int	The count of env.

getEnvList()

public ProtocolStringList getEnvList()

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Returns

Type	Description
ProtocolStringList	A list containing the env.

getExitCode()

public int getExitCode()

Output only. Return code from running the step.

int32 exit_code = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int	The exitCode.

getId()

public String getId()

Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

string id = 5;

Returns

Type	Description
String	The id.

getIdBytes()

public ByteString getIdBytes()

Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

string id = 5;

Returns

Type	Description
ByteString	The bytes for id.

getName()

public String getName()

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getPullTiming()

public TimeSpan getPullTiming()

Output only. Stores timing information for pulling this build step's builder image only.

.google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimeSpan	The pullTiming.

getPullTimingBuilder()

public TimeSpan.Builder getPullTimingBuilder()

Output only. Stores timing information for pulling this build step's builder image only.

.google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimeSpan.Builder

getPullTimingOrBuilder()

public TimeSpanOrBuilder getPullTimingOrBuilder()

Output only. Stores timing information for pulling this build step's builder image only.

.google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimeSpanOrBuilder

getScript()

public String getScript()

A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.

string script = 19;

Returns

Type	Description
String	The script.

getScriptBytes()

public ByteString getScriptBytes()

A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.

string script = 19;

Returns

Type	Description
ByteString	The bytes for script.

getSecretEnv(int index)

public String getSecretEnv(int index)

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The secretEnv at the given index.

getSecretEnvBytes(int index)

public ByteString getSecretEnvBytes(int index)

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the secretEnv at the given index.

getSecretEnvCount()

public int getSecretEnvCount()

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Returns

Type	Description
int	The count of secretEnv.

getSecretEnvList()

public ProtocolStringList getSecretEnvList()

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Returns

Type	Description
ProtocolStringList	A list containing the secretEnv.

getStatus()

public Build.Status getStatus()

Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.

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

Returns

Type	Description
Build.Status	The status.

getStatusValue()

public int getStatusValue()

Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.

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

Returns

Type	Description
int	The enum numeric value on the wire for status.

getTimeout()

public Duration getTimeout()

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

.google.protobuf.Duration timeout = 11;

Returns

Type	Description
Duration	The timeout.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

.google.protobuf.Duration timeout = 11;

Returns

Type	Description
Builder

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

.google.protobuf.Duration timeout = 11;

Returns

Type	Description
DurationOrBuilder

getTiming()

public TimeSpan getTiming()

Output only. Stores timing information for executing this build step.

.google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimeSpan	The timing.

getTimingBuilder()

public TimeSpan.Builder getTimingBuilder()

Output only. Stores timing information for executing this build step.

.google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimeSpan.Builder

getTimingOrBuilder()

public TimeSpanOrBuilder getTimingOrBuilder()

Output only. Stores timing information for executing this build step.

.google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimeSpanOrBuilder

getVolumes(int index)

public Volume getVolumes(int index)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Volume

getVolumesBuilder(int index)

public Volume.Builder getVolumesBuilder(int index)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Volume.Builder

getVolumesBuilderList()

public List<Volume.Builder> getVolumesBuilderList()

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Returns

Type	Description
List<Builder>

getVolumesCount()

public int getVolumesCount()

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Returns

Type	Description
int

getVolumesList()

public List<Volume> getVolumesList()

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Returns

Type	Description
List<Volume>

getVolumesOrBuilder(int index)

public VolumeOrBuilder getVolumesOrBuilder(int index)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameter

Name	Description
index	`int`

Returns

Type	Description
VolumeOrBuilder

getVolumesOrBuilderList()

public List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Returns

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

getWaitFor(int index)

public String getWaitFor(int index)

repeated string wait_for = 6;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The waitFor at the given index.

getWaitForBytes(int index)

public ByteString getWaitForBytes(int index)

repeated string wait_for = 6;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the waitFor at the given index.

getWaitForCount()

public int getWaitForCount()

repeated string wait_for = 6;

Returns

Type	Description
int	The count of waitFor.

getWaitForList()

public ProtocolStringList getWaitForList()

repeated string wait_for = 6;

Returns

Type	Description
ProtocolStringList	A list containing the waitFor.

hasPullTiming()

public boolean hasPullTiming()

Output only. Stores timing information for pulling this build step's builder image only.

.google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the pullTiming field is set.

hasTimeout()

public boolean hasTimeout()

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

.google.protobuf.Duration timeout = 11;

Returns

Type	Description
boolean	Whether the timeout field is set.

hasTiming()

public boolean hasTiming()

Output only. Stores timing information for executing this build step.

.google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the timing field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(BuildStep other)

public BuildStep.Builder mergeFrom(BuildStep other)

Parameter

Name	Description
other	`BuildStep`

Returns

Type	Description
BuildStep.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BuildStep.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
BuildStep.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public BuildStep.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
BuildStep.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergePullTiming(TimeSpan value)

public BuildStep.Builder mergePullTiming(TimeSpan value)

Output only. Stores timing information for pulling this build step's builder image only.

.google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`TimeSpan`

Returns

Type	Description
BuildStep.Builder

mergeTimeout(Duration value)

public BuildStep.Builder mergeTimeout(Duration value)

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

.google.protobuf.Duration timeout = 11;

Parameter

Name	Description
value	`Duration`

Returns

Type	Description
BuildStep.Builder

mergeTiming(TimeSpan value)

public BuildStep.Builder mergeTiming(TimeSpan value)

Output only. Stores timing information for executing this build step.

.google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`TimeSpan`

Returns

Type	Description
BuildStep.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BuildStep.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeVolumes(int index)

public BuildStep.Builder removeVolumes(int index)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BuildStep.Builder

setAllowExitCodes(int index, int value)

public BuildStep.Builder setAllowExitCodes(int index, int value)

Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.

repeated int32 allow_exit_codes = 18;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`int` The allowExitCodes to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setAllowFailure(boolean value)

public BuildStep.Builder setAllowFailure(boolean value)

bool allow_failure = 14;

Parameter

Name	Description
value	`boolean` The allowFailure to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setArgs(int index, String value)

public BuildStep.Builder setArgs(int index, String value)

repeated string args = 3;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The args to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setDir(String value)

public BuildStep.Builder setDir(String value)

string dir = 4;

Parameter

Name	Description
value	`String` The dir to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setDirBytes(ByteString value)

public BuildStep.Builder setDirBytes(ByteString value)

string dir = 4;

Parameter

Name	Description
value	`ByteString` The bytes for dir to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setEntrypoint(String value)

public BuildStep.Builder setEntrypoint(String value)

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

string entrypoint = 7;

Parameter

Name	Description
value	`String` The entrypoint to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setEntrypointBytes(ByteString value)

public BuildStep.Builder setEntrypointBytes(ByteString value)

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

string entrypoint = 7;

Parameter

Name	Description
value	`ByteString` The bytes for entrypoint to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setEnv(int index, String value)

public BuildStep.Builder setEnv(int index, String value)

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

repeated string env = 2;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The env to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setExitCode(int value)

public BuildStep.Builder setExitCode(int value)

Output only. Return code from running the step.

int32 exit_code = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`int` The exitCode to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BuildStep.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setId(String value)

public BuildStep.Builder setId(String value)

Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

string id = 5;

Parameter

Name	Description
value	`String` The id to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setIdBytes(ByteString value)

public BuildStep.Builder setIdBytes(ByteString value)

Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

string id = 5;

Parameter

Name	Description
value	`ByteString` The bytes for id to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setName(String value)

public BuildStep.Builder setName(String value)

string name = 1;

Parameter

Name	Description
value	`String` The name to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setNameBytes(ByteString value)

public BuildStep.Builder setNameBytes(ByteString value)

string name = 1;

Parameter

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setPullTiming(TimeSpan value)

public BuildStep.Builder setPullTiming(TimeSpan value)

Output only. Stores timing information for pulling this build step's builder image only.

.google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`TimeSpan`

Returns

Type	Description
BuildStep.Builder

setPullTiming(TimeSpan.Builder builderForValue)

public BuildStep.Builder setPullTiming(TimeSpan.Builder builderForValue)

Output only. Stores timing information for pulling this build step's builder image only.

.google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	`TimeSpan.Builder`

Returns

Type	Description
BuildStep.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BuildStep.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setScript(String value)

public BuildStep.Builder setScript(String value)

A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.

string script = 19;

Parameter

Name	Description
value	`String` The script to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setScriptBytes(ByteString value)

public BuildStep.Builder setScriptBytes(ByteString value)

A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.

string script = 19;

Parameter

Name	Description
value	`ByteString` The bytes for script to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setSecretEnv(int index, String value)

public BuildStep.Builder setSecretEnv(int index, String value)

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

repeated string secret_env = 8;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The secretEnv to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setStatus(Build.Status value)

public BuildStep.Builder setStatus(Build.Status value)

Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.

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

Parameter

Name	Description
value	`Build.Status` The status to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setStatusValue(int value)

public BuildStep.Builder setStatusValue(int value)

Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.

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

Parameter

Name	Description
value	`int` The enum numeric value on the wire for status to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.

setTimeout(Duration value)

public BuildStep.Builder setTimeout(Duration value)

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

.google.protobuf.Duration timeout = 11;

Parameter

Name	Description
value	`Duration`

Returns

Type	Description
BuildStep.Builder

setTimeout(Duration.Builder builderForValue)

public BuildStep.Builder setTimeout(Duration.Builder builderForValue)

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

.google.protobuf.Duration timeout = 11;

Parameter

Name	Description
builderForValue	`Builder`

Returns

Type	Description
BuildStep.Builder

setTiming(TimeSpan value)

public BuildStep.Builder setTiming(TimeSpan value)

Output only. Stores timing information for executing this build step.

.google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`TimeSpan`

Returns

Type	Description
BuildStep.Builder

setTiming(TimeSpan.Builder builderForValue)

public BuildStep.Builder setTiming(TimeSpan.Builder builderForValue)

Output only. Stores timing information for executing this build step.

.google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	`TimeSpan.Builder`

Returns

Type	Description
BuildStep.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final BuildStep.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
BuildStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVolumes(int index, Volume value)

public BuildStep.Builder setVolumes(int index, Volume value)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameters

Name	Description
index	`int`
value	`Volume`

Returns

Type	Description
BuildStep.Builder

setVolumes(int index, Volume.Builder builderForValue)

public BuildStep.Builder setVolumes(int index, Volume.Builder builderForValue)

repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;

Parameters

Name	Description
index	`int`
builderForValue	`Volume.Builder`

Returns

Type	Description
BuildStep.Builder

setWaitFor(int index, String value)

public BuildStep.Builder setWaitFor(int index, String value)

repeated string wait_for = 6;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The waitFor to set.

Returns

Type	Description
BuildStep.Builder	This builder for chaining.