Package com.google.devtools.build.lib.query2.proto.proto2api

Interface Build.RuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Build.Rule, Build.Rule.Builder
Enclosing class:
Build
public static interface Build.RuleOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasName

      boolean hasName()
       The name of the rule (formatted as an absolute label, e.g. //foo/bar:baz).
      required string name = 1;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       The name of the rule (formatted as an absolute label, e.g. //foo/bar:baz).
      required string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the rule (formatted as an absolute label, e.g. //foo/bar:baz).
      required string name = 1;
      Returns:
      The bytes for name.

    • hasRuleClass

      boolean hasRuleClass()
       The rule class name (e.g., java_library).

 Note that the rule class name may not uniquely identify a rule class, since
 two different .bzl files may define different rule classes with the same
 name. To uniquely identify the rule class, see rule_class_key field below.
      required string rule_class = 2;
      Returns:
      Whether the ruleClass field is set.

    • getRuleClass

      String getRuleClass()
       The rule class name (e.g., java_library).

 Note that the rule class name may not uniquely identify a rule class, since
 two different .bzl files may define different rule classes with the same
 name. To uniquely identify the rule class, see rule_class_key field below.
      required string rule_class = 2;
      Returns:
      The ruleClass.

    • getRuleClassBytes

      com.google.protobuf.ByteString getRuleClassBytes()
       The rule class name (e.g., java_library).

 Note that the rule class name may not uniquely identify a rule class, since
 two different .bzl files may define different rule classes with the same
 name. To uniquely identify the rule class, see rule_class_key field below.
      required string rule_class = 2;
      Returns:
      The bytes for ruleClass.

    • hasLocation

      boolean hasLocation()
       The BUILD file and line number of the location (formatted as
 <absolute_path>:<line_number>:<column_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://bazel.build/rules/macros#macro-creation
      optional string location = 3;
      Returns:
      Whether the location field is set.

    • getLocation

      String getLocation()
       The BUILD file and line number of the location (formatted as
 <absolute_path>:<line_number>:<column_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://bazel.build/rules/macros#macro-creation
      optional string location = 3;
      Returns:
      The location.

    • getLocationBytes

      com.google.protobuf.ByteString getLocationBytes()
       The BUILD file and line number of the location (formatted as
 <absolute_path>:<line_number>:<column_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://bazel.build/rules/macros#macro-creation
      optional string location = 3;
      Returns:
      The bytes for location.

    • getAttributeList

      List<Build.Attribute> getAttributeList()
       All of the attributes that describe the rule.
      repeated .blaze_query.Attribute attribute = 4;

    • getAttribute

      Build.Attribute getAttribute(int index)
       All of the attributes that describe the rule.
      repeated .blaze_query.Attribute attribute = 4;

    • getAttributeCount

      int getAttributeCount()
       All of the attributes that describe the rule.
      repeated .blaze_query.Attribute attribute = 4;

    • getAttributeOrBuilderList

      List<? extends Build.AttributeOrBuilder> getAttributeOrBuilderList()
       All of the attributes that describe the rule.
      repeated .blaze_query.Attribute attribute = 4;

    • getAttributeOrBuilder

      Build.AttributeOrBuilder getAttributeOrBuilder(int index)
       All of the attributes that describe the rule.
      repeated .blaze_query.Attribute attribute = 4;

    • getRuleInputList

      List<String> getRuleInputList()
       All of the inputs to the rule (formatted as absolute labels). These are
 predecessors in the dependency graph.
      repeated string rule_input = 5;
      Returns:
      A list containing the ruleInput.

    • getRuleInputCount

      int getRuleInputCount()
       All of the inputs to the rule (formatted as absolute labels). These are
 predecessors in the dependency graph.
      repeated string rule_input = 5;
      Returns:
      The count of ruleInput.

    • getRuleInput

      String getRuleInput(int index)
       All of the inputs to the rule (formatted as absolute labels). These are
 predecessors in the dependency graph.
      repeated string rule_input = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The ruleInput at the given index.

    • getRuleInputBytes

      com.google.protobuf.ByteString getRuleInputBytes(int index)
       All of the inputs to the rule (formatted as absolute labels). These are
 predecessors in the dependency graph.
      repeated string rule_input = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ruleInput at the given index.

    • getConfiguredRuleInputList

      List<Build.ConfiguredRuleInput> getConfiguredRuleInputList()
      repeated .blaze_query.ConfiguredRuleInput configured_rule_input = 15;

    • getConfiguredRuleInput

      Build.ConfiguredRuleInput getConfiguredRuleInput(int index)
      repeated .blaze_query.ConfiguredRuleInput configured_rule_input = 15;

    • getConfiguredRuleInputCount

      int getConfiguredRuleInputCount()
      repeated .blaze_query.ConfiguredRuleInput configured_rule_input = 15;

    • getConfiguredRuleInputOrBuilderList

      List<? extends Build.ConfiguredRuleInputOrBuilder> getConfiguredRuleInputOrBuilderList()
      repeated .blaze_query.ConfiguredRuleInput configured_rule_input = 15;

    • getConfiguredRuleInputOrBuilder

      Build.ConfiguredRuleInputOrBuilder getConfiguredRuleInputOrBuilder(int index)
      repeated .blaze_query.ConfiguredRuleInput configured_rule_input = 15;

    • getRuleOutputList

      List<String> getRuleOutputList()
       All of the outputs of the rule (formatted as absolute labels). These are
 successors in the dependency graph.
      repeated string rule_output = 6;
      Returns:
      A list containing the ruleOutput.

    • getRuleOutputCount

      int getRuleOutputCount()
       All of the outputs of the rule (formatted as absolute labels). These are
 successors in the dependency graph.
      repeated string rule_output = 6;
      Returns:
      The count of ruleOutput.

    • getRuleOutput

      String getRuleOutput(int index)
       All of the outputs of the rule (formatted as absolute labels). These are
 successors in the dependency graph.
      repeated string rule_output = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The ruleOutput at the given index.

    • getRuleOutputBytes

      com.google.protobuf.ByteString getRuleOutputBytes(int index)
       All of the outputs of the rule (formatted as absolute labels). These are
 successors in the dependency graph.
      repeated string rule_output = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ruleOutput at the given index.

    • getDefaultSettingList

      List<String> getDefaultSettingList()
       The set of all "features" inherited from the rule's package declaration.
      repeated string default_setting = 7;
      Returns:
      A list containing the defaultSetting.

    • getDefaultSettingCount

      int getDefaultSettingCount()
       The set of all "features" inherited from the rule's package declaration.
      repeated string default_setting = 7;
      Returns:
      The count of defaultSetting.

    • getDefaultSetting

      String getDefaultSetting(int index)
       The set of all "features" inherited from the rule's package declaration.
      repeated string default_setting = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The defaultSetting at the given index.

    • getDefaultSettingBytes

      com.google.protobuf.ByteString getDefaultSettingBytes(int index)
       The set of all "features" inherited from the rule's package declaration.
      repeated string default_setting = 7;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the defaultSetting at the given index.

    • hasDEPRECATEDPublicByDefault

      boolean hasDEPRECATEDPublicByDefault()
       The rule's class's public by default value.
      optional bool DEPRECATED_public_by_default = 9;
      Returns:
      Whether the dEPRECATEDPublicByDefault field is set.

    • getDEPRECATEDPublicByDefault

      boolean getDEPRECATEDPublicByDefault()
       The rule's class's public by default value.
      optional bool DEPRECATED_public_by_default = 9;
      Returns:
      The dEPRECATEDPublicByDefault.

    • hasDEPRECATEDIsSkylark

      boolean hasDEPRECATEDIsSkylark()
      optional bool DEPRECATED_is_skylark = 10;
      Returns:
      Whether the dEPRECATEDIsSkylark field is set.

    • getDEPRECATEDIsSkylark

      boolean getDEPRECATEDIsSkylark()
      optional bool DEPRECATED_is_skylark = 10;
      Returns:
      The dEPRECATEDIsSkylark.

    • hasSkylarkEnvironmentHashCode

      boolean hasSkylarkEnvironmentHashCode()
       Hash encapsulating the behavior of this Starlark rule. Any change to this
 rule's definition that could change its behavior will be reflected here.
      optional string skylark_environment_hash_code = 12;
      Returns:
      Whether the skylarkEnvironmentHashCode field is set.

    • getSkylarkEnvironmentHashCode

      String getSkylarkEnvironmentHashCode()
       Hash encapsulating the behavior of this Starlark rule. Any change to this
 rule's definition that could change its behavior will be reflected here.
      optional string skylark_environment_hash_code = 12;
      Returns:
      The skylarkEnvironmentHashCode.

    • getSkylarkEnvironmentHashCodeBytes

      com.google.protobuf.ByteString getSkylarkEnvironmentHashCodeBytes()
       Hash encapsulating the behavior of this Starlark rule. Any change to this
 rule's definition that could change its behavior will be reflected here.
      optional string skylark_environment_hash_code = 12;
      Returns:
      The bytes for skylarkEnvironmentHashCode.

    • getInstantiationStackList

      List<String> getInstantiationStackList()
       The Starlark call stack at the moment the rule was instantiated.
 Each entry has the form "file:line:col: function".
 The outermost stack frame ("<toplevel>", the BUILD file) appears first;
 the frame for the rule function itself is omitted.
 The file name may be relative to package's source root directory.

 Requires --proto:instantiation_stack=true.
      repeated string instantiation_stack = 13;
      Returns:
      A list containing the instantiationStack.

    • getInstantiationStackCount

      int getInstantiationStackCount()
       The Starlark call stack at the moment the rule was instantiated.
 Each entry has the form "file:line:col: function".
 The outermost stack frame ("<toplevel>", the BUILD file) appears first;
 the frame for the rule function itself is omitted.
 The file name may be relative to package's source root directory.

 Requires --proto:instantiation_stack=true.
      repeated string instantiation_stack = 13;
      Returns:
      The count of instantiationStack.

    • getInstantiationStack

      String getInstantiationStack(int index)
       The Starlark call stack at the moment the rule was instantiated.
 Each entry has the form "file:line:col: function".
 The outermost stack frame ("<toplevel>", the BUILD file) appears first;
 the frame for the rule function itself is omitted.
 The file name may be relative to package's source root directory.

 Requires --proto:instantiation_stack=true.
      repeated string instantiation_stack = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The instantiationStack at the given index.

    • getInstantiationStackBytes

      com.google.protobuf.ByteString getInstantiationStackBytes(int index)
       The Starlark call stack at the moment the rule was instantiated.
 Each entry has the form "file:line:col: function".
 The outermost stack frame ("<toplevel>", the BUILD file) appears first;
 the frame for the rule function itself is omitted.
 The file name may be relative to package's source root directory.

 Requires --proto:instantiation_stack=true.
      repeated string instantiation_stack = 13;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the instantiationStack at the given index.

    • getDefinitionStackList

      List<String> getDefinitionStackList()
       The Starlark call stack for the definition of the rule class of this
 particular rule instance. If empty, either populating the field was not
 enabled on the command line with the --proto:definition_stack flag or the
 rule is a native one.
      repeated string definition_stack = 14;
      Returns:
      A list containing the definitionStack.

    • getDefinitionStackCount

      int getDefinitionStackCount()
       The Starlark call stack for the definition of the rule class of this
 particular rule instance. If empty, either populating the field was not
 enabled on the command line with the --proto:definition_stack flag or the
 rule is a native one.
      repeated string definition_stack = 14;
      Returns:
      The count of definitionStack.

    • getDefinitionStack

      String getDefinitionStack(int index)
       The Starlark call stack for the definition of the rule class of this
 particular rule instance. If empty, either populating the field was not
 enabled on the command line with the --proto:definition_stack flag or the
 rule is a native one.
      repeated string definition_stack = 14;
      Parameters:
      index - The index of the element to return.
      Returns:
      The definitionStack at the given index.

    • getDefinitionStackBytes

      com.google.protobuf.ByteString getDefinitionStackBytes(int index)
       The Starlark call stack for the definition of the rule class of this
 particular rule instance. If empty, either populating the field was not
 enabled on the command line with the --proto:definition_stack flag or the
 rule is a native one.
      repeated string definition_stack = 14;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the definitionStack at the given index.

    • hasRuleClassKey

      boolean hasRuleClassKey()
       A key uniquely identifying the rule's rule class. Stable between repeated
 blaze query invocations (assuming that there are no changes to Starlark
 files and the same blaze binary is invoked with the same options).

 Requires --proto:rule_classes=true
      optional string rule_class_key = 16;
      Returns:
      Whether the ruleClassKey field is set.

    • getRuleClassKey

      String getRuleClassKey()
       A key uniquely identifying the rule's rule class. Stable between repeated
 blaze query invocations (assuming that there are no changes to Starlark
 files and the same blaze binary is invoked with the same options).

 Requires --proto:rule_classes=true
      optional string rule_class_key = 16;
      Returns:
      The ruleClassKey.

    • getRuleClassKeyBytes

      com.google.protobuf.ByteString getRuleClassKeyBytes()
       A key uniquely identifying the rule's rule class. Stable between repeated
 blaze query invocations (assuming that there are no changes to Starlark
 files and the same blaze binary is invoked with the same options).

 Requires --proto:rule_classes=true
      optional string rule_class_key = 16;
      Returns:
      The bytes for ruleClassKey.

    • hasRuleClassInfo

      boolean hasRuleClassInfo()
       Stardoc-format rule class API definition for this rule. Includes both
 Starlark-defined and native (including inherited) attributes; does not
 include hidden or explicitly undocumented attributes.

 Populated only for the first rule in the stream with a given
 rule_class_key.

 Requires --proto:rule_classes=true
      optional .stardoc_output.RuleInfo rule_class_info = 17;
      Returns:
      Whether the ruleClassInfo field is set.

    • getRuleClassInfo

      StardocOutputProtos.RuleInfo getRuleClassInfo()
       Stardoc-format rule class API definition for this rule. Includes both
 Starlark-defined and native (including inherited) attributes; does not
 include hidden or explicitly undocumented attributes.

 Populated only for the first rule in the stream with a given
 rule_class_key.

 Requires --proto:rule_classes=true
      optional .stardoc_output.RuleInfo rule_class_info = 17;
      Returns:
      The ruleClassInfo.

    • getRuleClassInfoOrBuilder

      StardocOutputProtos.RuleInfoOrBuilder getRuleClassInfoOrBuilder()
       Stardoc-format rule class API definition for this rule. Includes both
 Starlark-defined and native (including inherited) attributes; does not
 include hidden or explicitly undocumented attributes.

 Populated only for the first rule in the stream with a given
 rule_class_key.

 Requires --proto:rule_classes=true
      optional .stardoc_output.RuleInfo rule_class_info = 17;