WorkRequest class
This represents a single work unit that Blaze sends to the worker.
- Inheritance
-
- Object
- GeneratedMessage
- WorkRequest
Constructors
-
WorkRequest({Iterable<
String> ? arguments, Iterable<Input> ? inputs, int? requestId, bool? cancel, int? verbosity, String? sandboxDir}) -
factory
-
WorkRequest.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- WorkRequest.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
-
arguments
→ List<
String> -
no setter
- cancel ↔ bool
-
EXPERIMENTAL: When true, this is a cancel request, indicating that a
previously sent WorkRequest with the same request_id should be cancelled.
The arguments and inputs fields must be empty and should be ignored.
getter/setter pair
- 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
- info_ → BuilderInfo
-
no setteroverride
-
inputs
→ List<
Input> -
The inputs that the worker is allowed to read during execution of this
request.
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - requestId ↔ int
-
Each WorkRequest must have either a unique
request_id or request_id = 0. If request_id is 0, this WorkRequest must be
processed alone (singleplex), otherwise the worker may process multiple
WorkRequests in parallel (multiplexing). As an exception to the above, if
the cancel field is true, the request_id must be the same as a previously
sent WorkRequest. The request_id must be attached unchanged to the
corresponding WorkResponse. Only one singleplex request may be sent to a
worker at a time.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sandboxDir ↔ String
-
The relative directory inside the workers working directory where the
inputs and outputs are placed, for sandboxing purposes. For singleplex
workers, this is unset, as they can use their working directory as sandbox.
For multiplex workers, this will be set when the
--experimental_worker_multiplex_sandbox flag is set and the execution
requirements for the worker includes 'supports-multiplex-sandbox'.
The paths in
inputswill not contain this prefix, but the actual files will be placed/must be written relative to this directory. The worker implementation is responsible for resolving the file paths.getter/setter pair - unknownFields → UnknownFieldSet
-
no setterinherited
- verbosity ↔ int
-
Values greater than 0 indicate that the worker may output extra debug
information to stderr (which will go into the worker log). Setting the
--worker_verbose flag for Bazel makes this flag default to 10.
getter/setter pair
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
-
clearCancel(
) → 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
-
clearRequestId(
) → void -
clearSandboxDir(
) → void -
clearVerbosity(
) → void -
clone(
) → WorkRequest -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(WorkRequest)) → WorkRequest -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → WorkRequest -
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
-
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
-
hasCancel(
) → 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 -
hasRequestId(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasSandboxDir(
) → bool -
hasVerbosity(
) → 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(
) → WorkRequest -
createRepeated(
) → PbList< WorkRequest> -
getDefault(
) → WorkRequest