Package com.google.devtools.build.lib.runtime.proto

Interface InvocationPolicyOuterClass.SetValueOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getAppend()
      If true, and if the flag named in the policy is a repeatable flag, then the values listed in flag_value do not replace all the user-set or default values of the flag, but instead append to them.
      InvocationPolicyOuterClass.SetValue.Behavior getBehavior()
      Defines how invocation policy should interact with user settings for the same flag.
      java.lang.String getFlagValue​(int index)
      Use this value for the specified flag, overriding any default or user-set value (unless append is set to true for repeatable flags).
      com.google.protobuf.ByteString getFlagValueBytes​(int index)
      Use this value for the specified flag, overriding any default or user-set value (unless append is set to true for repeatable flags).
      int getFlagValueCount()
      Use this value for the specified flag, overriding any default or user-set value (unless append is set to true for repeatable flags).
      java.util.List<java.lang.String> getFlagValueList()
      Use this value for the specified flag, overriding any default or user-set value (unless append is set to true for repeatable flags).
      boolean getOverridable()
      Whether to allow this policy to be overridden by user-specified values.
      boolean hasAppend()
      If true, and if the flag named in the policy is a repeatable flag, then the values listed in flag_value do not replace all the user-set or default values of the flag, but instead append to them.
      boolean hasBehavior()
      Defines how invocation policy should interact with user settings for the same flag.
      boolean hasOverridable()
      Whether to allow this policy to be overridden by user-specified values.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getFlagValueList

        java.util.List<java.lang.String> getFlagValueList()
         Use this value for the specified flag, overriding any default or user-set
 value (unless append is set to true for repeatable flags).
 This field is repeated for repeatable flags. It is an error to set
 multiple values for a flag that is not actually a repeatable flag.
 This requires at least 1 value, if even the empty string.
 If the flag allows multiple values, all of its values are replaced with the
 value or values from the policy (i.e., no diffing or merging is performed),
 unless the append field (see below) is set to true.
 Note that some flags are tricky. For example, some flags look like boolean
 flags, but are actually Void expansion flags that expand into other flags.
 The Bazel flag parser will accept "--void_flag=false", but because
 the flag is Void, the "=false" is ignored. It can get even trickier, like
 "--novoid_flag" which is also an expansion flag with the type Void whose
 name is explicitly "novoid_flag" and which expands into other flags that
 are the opposite of "--void_flag". For expansion flags, it's best to
 explicitly override the flags they expand into.
 Other flags may be differently tricky: A flag could have a converter that
 converts some string to a list of values, but that flag may not itself have
 allowMultiple set to true.
 An example is "--test_tag_filters": this flag sets its converter to
 CommaSeparatedOptionListConverter, but does not set allowMultiple to true.
 So "--test_tag_filters=foo,bar" results in ["foo", "bar"], however
 "--test_tag_filters=foo --test_tag_filters=bar" results in just ["bar"]
 since the 2nd value overrides the 1st.
 Similarly, "--test_tag_filters=foo,bar --test_tag_filters=baz,qux" results
 in ["baz", "qux"]. For flags like these, the policy should specify
 "foo,bar" instead of separately specifying "foo" and "bar" so that the
 converter is appropriately invoked.
 Note that the opposite is not necessarily
 true: for a flag that specifies allowMultiple=true, "--flag=foo,bar"
 may fail to parse or result in an unexpected value.
        repeated string flag_value = 1;
        Returns:
        A list containing the flagValue.

      • getFlagValueCount

        int getFlagValueCount()
         Use this value for the specified flag, overriding any default or user-set
 value (unless append is set to true for repeatable flags).
 This field is repeated for repeatable flags. It is an error to set
 multiple values for a flag that is not actually a repeatable flag.
 This requires at least 1 value, if even the empty string.
 If the flag allows multiple values, all of its values are replaced with the
 value or values from the policy (i.e., no diffing or merging is performed),
 unless the append field (see below) is set to true.
 Note that some flags are tricky. For example, some flags look like boolean
 flags, but are actually Void expansion flags that expand into other flags.
 The Bazel flag parser will accept "--void_flag=false", but because
 the flag is Void, the "=false" is ignored. It can get even trickier, like
 "--novoid_flag" which is also an expansion flag with the type Void whose
 name is explicitly "novoid_flag" and which expands into other flags that
 are the opposite of "--void_flag". For expansion flags, it's best to
 explicitly override the flags they expand into.
 Other flags may be differently tricky: A flag could have a converter that
 converts some string to a list of values, but that flag may not itself have
 allowMultiple set to true.
 An example is "--test_tag_filters": this flag sets its converter to
 CommaSeparatedOptionListConverter, but does not set allowMultiple to true.
 So "--test_tag_filters=foo,bar" results in ["foo", "bar"], however
 "--test_tag_filters=foo --test_tag_filters=bar" results in just ["bar"]
 since the 2nd value overrides the 1st.
 Similarly, "--test_tag_filters=foo,bar --test_tag_filters=baz,qux" results
 in ["baz", "qux"]. For flags like these, the policy should specify
 "foo,bar" instead of separately specifying "foo" and "bar" so that the
 converter is appropriately invoked.
 Note that the opposite is not necessarily
 true: for a flag that specifies allowMultiple=true, "--flag=foo,bar"
 may fail to parse or result in an unexpected value.
        repeated string flag_value = 1;
        Returns:
        The count of flagValue.

      • getFlagValue

        java.lang.String getFlagValue​(int index)
         Use this value for the specified flag, overriding any default or user-set
 value (unless append is set to true for repeatable flags).
 This field is repeated for repeatable flags. It is an error to set
 multiple values for a flag that is not actually a repeatable flag.
 This requires at least 1 value, if even the empty string.
 If the flag allows multiple values, all of its values are replaced with the
 value or values from the policy (i.e., no diffing or merging is performed),
 unless the append field (see below) is set to true.
 Note that some flags are tricky. For example, some flags look like boolean
 flags, but are actually Void expansion flags that expand into other flags.
 The Bazel flag parser will accept "--void_flag=false", but because
 the flag is Void, the "=false" is ignored. It can get even trickier, like
 "--novoid_flag" which is also an expansion flag with the type Void whose
 name is explicitly "novoid_flag" and which expands into other flags that
 are the opposite of "--void_flag". For expansion flags, it's best to
 explicitly override the flags they expand into.
 Other flags may be differently tricky: A flag could have a converter that
 converts some string to a list of values, but that flag may not itself have
 allowMultiple set to true.
 An example is "--test_tag_filters": this flag sets its converter to
 CommaSeparatedOptionListConverter, but does not set allowMultiple to true.
 So "--test_tag_filters=foo,bar" results in ["foo", "bar"], however
 "--test_tag_filters=foo --test_tag_filters=bar" results in just ["bar"]
 since the 2nd value overrides the 1st.
 Similarly, "--test_tag_filters=foo,bar --test_tag_filters=baz,qux" results
 in ["baz", "qux"]. For flags like these, the policy should specify
 "foo,bar" instead of separately specifying "foo" and "bar" so that the
 converter is appropriately invoked.
 Note that the opposite is not necessarily
 true: for a flag that specifies allowMultiple=true, "--flag=foo,bar"
 may fail to parse or result in an unexpected value.
        repeated string flag_value = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The flagValue at the given index.

      • getFlagValueBytes

        com.google.protobuf.ByteString getFlagValueBytes​(int index)
         Use this value for the specified flag, overriding any default or user-set
 value (unless append is set to true for repeatable flags).
 This field is repeated for repeatable flags. It is an error to set
 multiple values for a flag that is not actually a repeatable flag.
 This requires at least 1 value, if even the empty string.
 If the flag allows multiple values, all of its values are replaced with the
 value or values from the policy (i.e., no diffing or merging is performed),
 unless the append field (see below) is set to true.
 Note that some flags are tricky. For example, some flags look like boolean
 flags, but are actually Void expansion flags that expand into other flags.
 The Bazel flag parser will accept "--void_flag=false", but because
 the flag is Void, the "=false" is ignored. It can get even trickier, like
 "--novoid_flag" which is also an expansion flag with the type Void whose
 name is explicitly "novoid_flag" and which expands into other flags that
 are the opposite of "--void_flag". For expansion flags, it's best to
 explicitly override the flags they expand into.
 Other flags may be differently tricky: A flag could have a converter that
 converts some string to a list of values, but that flag may not itself have
 allowMultiple set to true.
 An example is "--test_tag_filters": this flag sets its converter to
 CommaSeparatedOptionListConverter, but does not set allowMultiple to true.
 So "--test_tag_filters=foo,bar" results in ["foo", "bar"], however
 "--test_tag_filters=foo --test_tag_filters=bar" results in just ["bar"]
 since the 2nd value overrides the 1st.
 Similarly, "--test_tag_filters=foo,bar --test_tag_filters=baz,qux" results
 in ["baz", "qux"]. For flags like these, the policy should specify
 "foo,bar" instead of separately specifying "foo" and "bar" so that the
 converter is appropriately invoked.
 Note that the opposite is not necessarily
 true: for a flag that specifies allowMultiple=true, "--flag=foo,bar"
 may fail to parse or result in an unexpected value.
        repeated string flag_value = 1;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the flagValue at the given index.

      • hasOverridable

        boolean hasOverridable()
         Whether to allow this policy to be overridden by user-specified values.
 When set, if the user specified a value for this flag, use the value
 from the user, otherwise use the value specified in this policy.
 This value is redundant to behavior -- please keep it in sync with it.
        optional bool overridable = 2;
        Returns:
        Whether the overridable field is set.

      • getOverridable

        boolean getOverridable()
         Whether to allow this policy to be overridden by user-specified values.
 When set, if the user specified a value for this flag, use the value
 from the user, otherwise use the value specified in this policy.
 This value is redundant to behavior -- please keep it in sync with it.
        optional bool overridable = 2;
        Returns:
        The overridable.

      • hasAppend

        boolean hasAppend()
         If true, and if the flag named in the policy is a repeatable flag, then
 the values listed in flag_value do not replace all the user-set or default
 values of the flag, but instead append to them. If the flag is not
 repeatable, then this has no effect.
 This value is redundant to behavior -- please keep it in sync with it.
        optional bool append = 3;
        Returns:
        Whether the append field is set.

      • getAppend

        boolean getAppend()
         If true, and if the flag named in the policy is a repeatable flag, then
 the values listed in flag_value do not replace all the user-set or default
 values of the flag, but instead append to them. If the flag is not
 repeatable, then this has no effect.
 This value is redundant to behavior -- please keep it in sync with it.
        optional bool append = 3;
        Returns:
        The append.

      • hasBehavior

        boolean hasBehavior()
         Defines how invocation policy should interact with user settings for the
 same flag.
 For the time being, it coexists with overridable and append with duplicate
 semantics.Please fill both of the values as we migrate to use behavior
 only.
 TODO(b/186167747): Deprecate and remove append and overridable flag in
 favor of this one.
        optional .blaze.invocation_policy.SetValue.Behavior behavior = 4;
        Returns:
        Whether the behavior field is set.

      • getBehavior

        InvocationPolicyOuterClass.SetValue.Behavior getBehavior()
         Defines how invocation policy should interact with user settings for the
 same flag.
 For the time being, it coexists with overridable and append with duplicate
 semantics.Please fill both of the values as we migrate to use behavior
 only.
 TODO(b/186167747): Deprecate and remove append and overridable flag in
 favor of this one.
        optional .blaze.invocation_policy.SetValue.Behavior behavior = 4;
        Returns:
        The behavior.