Class BuildStep (3.16.0)

public final class BuildStep extends GeneratedMessageV3 implements BuildStepOrBuilder

A step in the build pipeline.

Protobuf type google.devtools.cloudbuild.v1.BuildStep

Inheritance

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

Implements

BuildStepOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOW_EXIT_CODES_FIELD_NUMBER

public static final int ALLOW_EXIT_CODES_FIELD_NUMBER

Field Value
Type	Description
`int`

ALLOW_FAILURE_FIELD_NUMBER

public static final int ALLOW_FAILURE_FIELD_NUMBER

Field Value
Type	Description
`int`

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER

Field Value
Type	Description
`int`

DIR_FIELD_NUMBER

public static final int DIR_FIELD_NUMBER

Field Value
Type	Description
`int`

ENTRYPOINT_FIELD_NUMBER

public static final int ENTRYPOINT_FIELD_NUMBER

Field Value
Type	Description
`int`

ENV_FIELD_NUMBER

public static final int ENV_FIELD_NUMBER

Field Value
Type	Description
`int`

EXIT_CODE_FIELD_NUMBER

public static final int EXIT_CODE_FIELD_NUMBER

Field Value
Type	Description
`int`

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

PULL_TIMING_FIELD_NUMBER

public static final int PULL_TIMING_FIELD_NUMBER

Field Value
Type	Description
`int`

SCRIPT_FIELD_NUMBER

public static final int SCRIPT_FIELD_NUMBER

Field Value
Type	Description
`int`

SECRET_ENV_FIELD_NUMBER

public static final int SECRET_ENV_FIELD_NUMBER

Field Value
Type	Description
`int`

STATUS_FIELD_NUMBER

public static final int STATUS_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`

VOLUMES_FIELD_NUMBER

public static final int VOLUMES_FIELD_NUMBER

Field Value
Type	Description
`int`

WAIT_FOR_FIELD_NUMBER

public static final int WAIT_FOR_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static BuildStep getDefaultInstance()

Returns
Type	Description
`BuildStep`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static BuildStep.Builder newBuilder()

Returns
Type	Description
`BuildStep.Builder`

newBuilder(BuildStep prototype)

public static BuildStep.Builder newBuilder(BuildStep prototype)

Parameter
Name	Description
`prototype`	`BuildStep`

Returns
Type	Description
`BuildStep.Builder`

parseDelimitedFrom(InputStream input)

public static BuildStep parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BuildStep parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static BuildStep parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BuildStep parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static BuildStep parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BuildStep parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static BuildStep parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BuildStep parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static BuildStep parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BuildStep parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static BuildStep parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BuildStep parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BuildStep`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<BuildStep> parser()

Returns
Type	Description
`Parser<BuildStep>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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()

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
`boolean`	The allowFailure.

getArgs(int index)

public String getArgs(int index)

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
`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`

getDir()

public String getDir()

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
`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()

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
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<BuildStep> getParserForType()

Returns
Type	Description
`Parser<BuildStep>`

Overrides

GeneratedMessageV3.getParserForType()

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.

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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.

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`

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

getVolumes(int index)

public Volume getVolumes(int index)

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.