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

Interface InvocationPolicyOuterClass.SetValueOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
InvocationPolicyOuterClass.SetValue, InvocationPolicyOuterClass.SetValue.Builder
Enclosing class:
InvocationPolicyOuterClass
public static interface InvocationPolicyOuterClass.SetValueOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    InvocationPolicyOuterClass.SetValue.Behavior
    getBehavior()
    Defines how invocation policy should interact with user settings for the same flag.
    String
    getFlagValue(int index)
    Use this value for the specified flag, overriding any default or user-set value (unless behavior = APPEND 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 behavior = APPEND for repeatable flags).
    int
    getFlagValueCount()
    Use this value for the specified flag, overriding any default or user-set value (unless behavior = APPEND for repeatable flags).
    List<String>
    getFlagValueList()
    Use this value for the specified flag, overriding any default or user-set value (unless behavior = APPEND for repeatable flags).
    boolean
    hasBehavior()
    Defines how invocation policy should interact with user settings for the same flag.

    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 Details

    • getFlagValueList

      List<String> getFlagValueList()
       Use this value for the specified flag, overriding any default or user-set
 value (unless behavior = APPEND 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 behavior = APPEND (see below).

 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 behavior = APPEND 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 behavior = APPEND (see below).

 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

      String getFlagValue(int index)
       Use this value for the specified flag, overriding any default or user-set
 value (unless behavior = APPEND 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 behavior = APPEND (see below).

 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 behavior = APPEND 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 behavior = APPEND (see below).

 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.

    • hasBehavior

      boolean hasBehavior()
       Defines how invocation policy should interact with user settings for the
 same flag.
      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.
      optional .blaze.invocation_policy.SetValue.Behavior behavior = 4;
      Returns:
      The behavior.