package blaze_query

Get desktop application:
View/edit binary Protocol Buffers messages

Information about allowed rule classes for a specific attribute of a rule.

Used in: AttributeDefinition

• required AllowedRuleClassInfo.AllowedRuleClasses policy = 1

• repeated string allowed_rule_class = 2

  Rule class names of rules allowed in this attribute, e.g "cc_library", "py_binary". Only present if the allowed_rule_classes field is set to SPECIFIED.

Used in: AllowedRuleClassInfo

• ANY = 1

  Any rule is allowed to be in this attribute

• SPECIFIED = 2

  Only the explicitly listed rules are allowed

A rule attribute. Each attribute must have a type and one of the various value fields populated - for the most part. Attributes of BOOLEAN and TRISTATE type may set all of the int, bool, and string values for backwards compatibility with clients that expect them to be set. Attributes of INTEGER, STRING, LABEL, LICENSE, BOOLEAN, and TRISTATE type may set *none* of the values. This can happen if the Attribute message is prepared for a client that doesn't support SELECTOR_LIST, but the rule has a selector list value for the attribute. (Selector lists for attributes of other types--the collection types--are handled differently when prepared for such a client. The possible collection values are gathered together and flattened.) By checking the type, the appropriate value can be extracted - see the comments on each type for the associated value. The order of lists comes from the blaze parsing. If an attribute is of a list type, the associated list should never be empty.

Used in: Rule, SkylarkAspect

• required string name = 1

  The name of the attribute

• optional Location DEPRECATED_parseable_location = 12

  The location of the target in the BUILD file in a machine-parseable form.

• optional bool explicitly_specified = 13

  Whether the attribute was explicitly specified

• optional bool nodep = 20

  If this attribute has a string value or a string list value, then this may be set to indicate that the value may be treated as a label that isn't a dependency of this attribute's rule.

• required Attribute.Discriminator type = 2

  The type of attribute. This message is used for all of the different attribute types so the discriminator helps for figuring out what is stored in the message.

• optional int32 int_value = 3

  If this attribute has an integer value this will be populated. Boolean and TriState also use this field as [0,1] and [-1,0,1] for [false, true] and [auto, no, yes] respectively.

• optional string string_value = 5

  If the attribute has a string value this will be populated. Label and path attributes use this field as the value even though the type may be LABEL or something else other than STRING.

• optional bool boolean_value = 14

  If the attribute has a boolean value this will be populated.

• optional Attribute.Tristate tristate_value = 15

  If the attribute is a Tristate value, this will be populated.

• repeated string string_list_value = 6

  The value of the attribute has a list of string values (label and path note from STRING applies here as well).

• optional License license = 7

  If this is a license attribute, the license information is stored here.

• repeated StringDictEntry string_dict_value = 8

  If this is a string dict, each entry will be stored here.

• repeated FilesetEntry fileset_list_value = 9

  If the attribute is part of a Fileset, the fileset entries are stored in this field.

• repeated LabelListDictEntry label_list_dict_value = 10

  If this is a label list dict, each entry will be stored here.

• repeated StringListDictEntry string_list_dict_value = 11

  If this is a string list dict, each entry will be stored here.

• repeated int32 int_list_value = 17

  The value of the attribute has a list of int32 values

• repeated LabelDictUnaryEntry label_dict_unary_value = 19

  If this is a label dict unary, each entry will be stored here.

• repeated LabelKeyedStringDictEntry label_keyed_string_dict_value = 22

  If this is a label-keyed string dict, each entry will be stored here.

• optional Attribute.SelectorList selector_list = 21

  If this attribute's value is an expression containing one or more select expressions, then its type is SELECTOR_LIST and a SelectorList will be stored here.

• repeated DEPRECATED_GlobCriteria DEPRECATED_glob_criteria = 16

• repeated bytes DEPRECATED_string_dict_unary_value = 18

Indicates the type of attribute.

Used in: Attribute, SelectorList, AttributeDefinition

• INTEGER = 1

  int_value

• STRING = 2

  string_value

• LABEL = 3

  string_value

• OUTPUT = 4

  string_value

• STRING_LIST = 5

  string_list_value

• LABEL_LIST = 6

  string_list_value

• OUTPUT_LIST = 7

  string_list_value

• DISTRIBUTION_SET = 8

  string_list_value - order is unimportant

• LICENSE = 9

  license

• STRING_DICT = 10

  string_dict_value

• FILESET_ENTRY_LIST = 11

  fileset_list_value

• LABEL_LIST_DICT = 12

  label_list_dict_value

• STRING_LIST_DICT = 13

  string_list_dict_value

• BOOLEAN = 14

  int, bool and string value

• TRISTATE = 15

  tristate, int and string value

• INTEGER_LIST = 16

  int_list_value

• UNKNOWN = 18

  unknown type, use only for build extensions

• LABEL_DICT_UNARY = 19

  label_dict_unary_value

• SELECTOR_LIST = 20

  selector_list

• LABEL_KEYED_STRING_DICT = 21

  label_keyed_string_dict

• DEPRECATED_STRING_DICT_UNARY = 17

Used in: SelectorList

• repeated SelectorEntry entries = 1

  The list of (label, value) pairs in the map that defines the selector. At this time, this cannot be empty, i.e. a selector has at least one entry.

• optional bool has_default_value = 2

  Whether or not this has any default values.

• optional string no_match_error = 3

  The error message when no condition matches.

Used in: Selector

• optional string label = 1

  The key of the selector entry. At this time, this is the label of a config_setting rule, or the pseudo-label "//conditions:default".

• optional bool is_default_value = 16

  True if the entry's value is the default value for the type as a result of the condition value being specified as None (ie: {"//condition": None}).

• optional int32 int_value = 2

  Exactly one of the following fields (except for glob_criteria) must be populated - note that the BOOLEAN and TRISTATE caveat in Attribute's comment does not apply here. The type field in the SelectorList containing this entry indicates which of these fields is populated, in accordance with the comments on Discriminator enum values above. (To be explicit: BOOLEAN populates the boolean_value field and TRISTATE populates the tristate_value field.)

• optional string string_value = 3

• optional bool boolean_value = 4

• optional Tristate tristate_value = 5

• repeated string string_list_value = 6

• optional License license = 7

• repeated StringDictEntry string_dict_value = 8

• repeated FilesetEntry fileset_list_value = 9

• repeated LabelListDictEntry label_list_dict_value = 10

• repeated StringListDictEntry string_list_dict_value = 11

• repeated int32 int_list_value = 13

• repeated LabelDictUnaryEntry label_dict_unary_value = 15

• repeated LabelKeyedStringDictEntry label_keyed_string_dict_value = 17

• repeated DEPRECATED_GlobCriteria DEPRECATED_glob_criteria = 12

• repeated bytes DEPRECATED_string_dict_unary_value = 14

Used in: Attribute

• optional Discriminator type = 1

  The type that this selector list evaluates to, and the type that each selector in the list evaluates to. At this time, this cannot be SELECTOR_LIST, i.e. selector lists do not nest.

• repeated Selector elements = 2

  The list of selector elements in this selector list. At this time, this cannot be empty, i.e. a selector list is never empty.

Values for the TriState field type.

Used in: Attribute, SelectorEntry

• NO = 0

• YES = 1

• AUTO = 2

A pairing of attribute name and a Skylark aspect that is applied to that attribute.

Used in: Rule

• required string attribute_name = 1

• required SkylarkAspect aspect = 2

This message represents a single attribute of a single rule.

Used in: RuleDefinition

• required string name = 1

  Attribute name, i.e. "name", "srcs", "deps"

• required Attribute.Discriminator type = 2

• required bool mandatory = 3

• optional AllowedRuleClassInfo allowed_rule_classes = 4

  Only present for attributes of type LABEL and LABEL_LIST.

• optional string documentation = 5

• repeated RuleDefinition rule = 1

  Only contains documented rule definitions

Used in: Attribute, Attribute.SelectorEntry

• repeated string include = 1

  List of includes (or items if this criteria did not come from a glob)

• repeated string exclude = 2

  List of exclude expressions

• optional bool glob = 3

  Whether this message came from a glob

An environment group.

Used in: Target

• required string name = 1

  The name of the environment group.

• repeated string environment = 2

  The environments that belong to this group (as labels).

• repeated string default = 3

  The member environments that rules implicitly support if not otherwise specified.

• required Event.EventKind kind = 1

• optional Location DEPRECATED_location = 2

• optional string message = 3

Used in: Event

• ERROR = 1

• WARNING = 2

• INFO = 3

• PROGRESS = 4

Represents an entry attribute of a Fileset rule in a build file.

Used in: Attribute, Attribute.SelectorEntry

• required string source = 1

  The label pointing to the source target where files are copied from.

• required string destination_directory = 2

  The relative path within the fileset rule where files will be mapped.

• optional bool files_present = 7

  Whether the files= attribute was specified. This is necessary because no files= attribute and files=[] mean different things.

• repeated string file = 3

  A list of file labels to include from the source directory.

• repeated string exclude = 4

  If this is a fileset entry representing files within the rule package, this lists relative paths to files that should be excluded from the set. This cannot contain values if 'file' also has values.

• optional FilesetEntry.SymlinkBehavior symlink_behavior = 5

  This field is optional because there will be some time when the new PB is used by tools depending on blaze query, but the new blaze version is not yet released. TODO(bazel-team): Make this field required once a version of Blaze is released that outputs this field.

• optional string strip_prefix = 6

  The prefix to strip from the path of the files in this FilesetEntry. Note that no value and the empty string as the value mean different things here.

Indicates what to do when a source file is actually a symlink.

Used in: FilesetEntry

• COPY = 1

• DEREFERENCE = 2

A file that is the output of a build rule.

Used in: Target

• required string name = 1

  The name of the generated file (a label).

• required string generating_rule = 2

  The label of the target that generates the file.

• optional string location = 3

  The path of the output file (not a label).

Used in: Attribute, Attribute.SelectorEntry

• required string key = 1

• required string value = 2

Used in: Attribute, Attribute.SelectorEntry

• required string key = 1

• required string value = 2

Used in: Attribute, Attribute.SelectorEntry

• required string key = 1

• repeated string value = 2

Used in: Attribute, Attribute.SelectorEntry, SourceFile

• repeated string license_type = 1

• repeated string exception = 2

Used in: Attribute, Event, PackageGroup, Rule, SourceFile

• optional int32 start_offset = 1

• optional int32 start_line = 2

• optional int32 start_column = 3

• optional int32 end_offset = 4

• optional int32 end_line = 5

• optional int32 end_column = 6

• required string name = 1

• repeated MakeVarBinding binding = 2

Used in: MakeVar

• required string value = 1

• required string platform_set_regexp = 2

A package group. Aside from the name, it contains the list of packages present in the group (as specified in the BUILD file).

Used in: Target

• required string name = 1

  The name of the package group

• repeated string contained_package = 2

  The list of packages as specified in the BUILD file. Currently this is only a list of packages, but some time in the future, there might be some type of wildcard mechanism.

• repeated string included_package_group = 3

  The list of sub package groups included in this one.

• optional Location DEPRECATED_parseable_location = 4

  The location of the target in the BUILD file in a machine-parseable form.

Container for all of the blaze query results.

• repeated Target target = 1

  All of the targets returned by the blaze query.

A rule instance (e.g., cc_library foo, java_binary bar).

Used in: RuleSummary, Target

• required string name = 1

  The name of the rule (formatted as an absolute label, e.g. //foo/bar:baz).

• required string rule_class = 2

  The rule class (e.g., java_library)

• optional string location = 3

  The BUILD file and line number of the location (formatted as <absolute_path>:<line_number>) in the rule's package's BUILD file where the rule instance was instantiated. The line number will be that of a rule invocation or macro call (that in turn invoked a rule). See https://docs.bazel.build/versions/master/skylark/macros.html#macro-creation

• repeated Attribute attribute = 4

  All of the attributes that describe the rule.

• repeated string rule_input = 5

  All of the inputs to the rule (formatted as absolute labels). These are predecessors in the dependency graph.

• repeated string rule_output = 6

  All of the outputs of the rule (formatted as absolute labels). These are successors in the dependency graph.

• repeated string default_setting = 7

  The set of all default settings affecting this rule. The name of a default setting is "<setting type>_<setting name>". There currently defined setting types are: - 'blaze': settings implemented in Blaze itself

• optional Location DEPRECATED_parseable_location = 8

  The location of the target in the BUILD file in a machine-parseable form.

• optional bool public_by_default = 9

  The rule's class's public by default value.

• optional bool is_skylark = 10

  If this rule is of a skylark-defined RuleClass.

• repeated AttributeAspect skylark_attribute_aspects = 11

  List of Skylark aspects that this rule applies.

• optional string skylark_environment_hash_code = 12

  Hash encapsulating the behavior of this Skylark rule. Any change to this rule's definition that could change its behavior will be reflected here.

Used in: BuildLanguage

• required string name = 1

• repeated AttributeDefinition attribute = 2

  Only contains documented attributes

• optional string documentation = 3

• optional string label = 4

  Only for build extensions: label to file that defines the extension

Summary of all transitive dependencies of 'rule,' where each dependent rule is included only once in the 'dependency' field. Gives complete information to analyze the single build target labeled rule.name, including optional location of target in BUILD file.

• required Rule rule = 1

• repeated Rule dependency = 2

• optional string location = 3

Aspect defined in Skylark.

Used in: AttributeAspect

• required string extension_file_label = 1

• required string exported_name = 2

• repeated Attribute attribute = 3

A file that is an input into the build system. Next-Id: 10

Used in: Target

• required string name = 1

  The name of the source file (a label).

• optional string location = 2

  The location of the source file. This is a path with line numbers, not a label in the build system.

• optional Location DEPRECATED_parseable_location = 7

  The location of the corresponding label in the BUILD file in a machine-parseable form.

• repeated string subinclude = 3

  Labels of .bzl (Skylark) files that are transitively loaded in this BUILD file. This is present only when the SourceFile represents a BUILD file that loaded .bzl files. TODO(bazel-team): Rename this field.

• repeated string package_group = 4

  Labels of package groups that are mentioned in the visibility declaration for this source file.

• repeated string visibility_label = 5

  Labels mentioned in the visibility declaration (including :__pkg__ and //visibility: ones)

• repeated string feature = 6

  The package-level features enabled for this package. Only present if the SourceFile represents a BUILD file.

• optional License license = 8

  License attribute for the file.

• optional bool package_contains_errors = 9

  True if the package contains an error. Only present if the SourceFile represents a BUILD file.

Used in: Attribute, Attribute.SelectorEntry

• required string key = 1

• required string value = 2

Used in: Attribute, Attribute.SelectorEntry

• required string key = 1

• repeated string value = 2

A target from a blaze query execution. Similar to the Attribute message, the Discriminator is used to determine which field contains information. For any given type, only one of these can be populated in a single Target.

Used in: QueryResult

• required Target.Discriminator type = 1

  The type of target contained in the message.

• optional Rule rule = 2

  If this target represents a rule, the rule is stored here.

• optional SourceFile source_file = 3

  A file that is not generated by the build system (version controlled or created by the test harness).

• optional GeneratedFile generated_file = 4

  A generated file that is the output of a rule.

• optional PackageGroup package_group = 5

  A package group.

• optional EnvironmentGroup environment_group = 6

  An environment group.

Used in: Target

• RULE = 1

• SOURCE_FILE = 2

• GENERATED_FILE = 3

• PACKAGE_GROUP = 4

• ENVIRONMENT_GROUP = 5