BuildStep class
A step in the build pipeline.
- Inheritance
-
- Object
- GeneratedMessage
- BuildStep
Constructors
-
BuildStep({String? name, Iterable<
String> ? env, Iterable<String> ? args, String? dir, String? id, Iterable<String> ? waitFor, String? entrypoint, Iterable<String> ? secretEnv, Iterable<Volume> ? volumes, TimeSpan? timing, Duration? timeout, BuildEventData_Status? status, TimeSpan? pullTiming}) -
factory
-
BuildStep.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- BuildStep.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
-
args
→ List<
String> -
A list of arguments that will be presented to the step when it is started.
no setter
- dir ↔ String
-
Working directory to use when running this step's container.
getter/setter pair
- entrypoint ↔ String
-
Entrypoint to be used instead of the build step image's default entrypoint.
If unset, the image's default entrypoint is used.
getter/setter pair
-
env
→ List<
String> -
A list of environment variable definitions to be used when running a step.
no setter
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- id ↔ String
-
Unique identifier for this build step, used in
wait_forto reference this build step as a dependency.getter/setter pair - info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - name ↔ String
-
The name of the container image that will run this particular
build step.
getter/setter pair
- pullTiming ↔ TimeSpan
-
Stores timing information for pulling this build step's
builder image only.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
secretEnv
→ List<
String> -
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.no setter - status ↔ BuildEventData_Status
-
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.
getter/setter pair
- timeout ↔ Duration
-
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.
getter/setter pair
- timing ↔ TimeSpan
-
Stores timing information for executing this build step.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
-
volumes
→ List<
Volume> -
List of volumes to mount into the build step.
no setter
-
waitFor
→ List<
String> -
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_forhave completed successfully. Ifwait_foris empty, this build step will start when all previous build steps in theBuild.Stepslist have completed successfully.no setter
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearDir(
) → void -
clearEntrypoint(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearId(
) → void -
clearName(
) → void -
clearPullTiming(
) → void -
clearStatus(
) → void -
clearTimeout(
) → void -
clearTiming(
) → void -
clone(
) → BuildStep -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(BuildStep)) → BuildStep -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → BuildStep -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
ensurePullTiming(
) → TimeSpan -
ensureTimeout(
) → Duration -
ensureTiming(
) → TimeSpan -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasDir(
) → bool -
hasEntrypoint(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasId(
) → bool -
hasName(
) → bool -
hasPullTiming(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasStatus(
) → bool -
hasTimeout(
) → bool -
hasTiming(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
inherited
-
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
inherited
-
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → BuildStep -
createRepeated(
) → PbList< BuildStep> -
getDefault(
) → BuildStep