Package com.google.devtools.build.lib.starlarkdocextract

Interface StardocOutputProtos.FunctionParamInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StardocOutputProtos.FunctionParamInfo, StardocOutputProtos.FunctionParamInfo.Builder
Enclosing class:
StardocOutputProtos
public static interface StardocOutputProtos.FunctionParamInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultValue()
    If not an empty string, the default value of the parameter displayed as a string.
    com.google.protobuf.ByteString
    getDefaultValueBytes()
    If not an empty string, the default value of the parameter displayed as a string.
    String
    getDocString()
    The documented description of the parameter (if specified in the function's docstring).
    com.google.protobuf.ByteString
    getDocStringBytes()
    The documented description of the parameter (if specified in the function's docstring).
    boolean
    getMandatory()
    If true, the default value is unset and a value is needed for this parameter.
    String
    getName()
    The name of the parameter.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the parameter.
    StardocOutputProtos.FunctionParamRole
    getRole()
    The parameter's syntactic role.
    int
    getRoleValue()
    The parameter's syntactic role.

    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

    • getName

      String getName()
       The name of the parameter. This does *not* include the `*` or `**` prefix
 for varargs or residual keyword argument parameters.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the parameter. This does *not* include the `*` or `**` prefix
 for varargs or residual keyword argument parameters.
      string name = 1;
      Returns:
      The bytes for name.

    • getDocString

      String getDocString()
       The documented description of the parameter (if specified in the function's
 docstring).
      string doc_string = 2;
      Returns:
      The docString.

    • getDocStringBytes

      com.google.protobuf.ByteString getDocStringBytes()
       The documented description of the parameter (if specified in the function's
 docstring).
      string doc_string = 2;
      Returns:
      The bytes for docString.

    • getDefaultValue

      String getDefaultValue()
       If not an empty string, the default value of the parameter displayed
 as a string.
      string default_value = 3;
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      com.google.protobuf.ByteString getDefaultValueBytes()
       If not an empty string, the default value of the parameter displayed
 as a string.
      string default_value = 3;
      Returns:
      The bytes for defaultValue.

    • getMandatory

      boolean getMandatory()
       If true, the default value is unset and a value is needed for this
 parameter. This might be false even if defaultValue is empty in the case of
 special parameter such as *args and **kwargs"
      bool mandatory = 4;
      Returns:
      The mandatory.

    • getRoleValue

      int getRoleValue()
       The parameter's syntactic role.
      .stardoc_output.FunctionParamRole role = 5;
      Returns:
      The enum numeric value on the wire for role.

    • getRole

      StardocOutputProtos.FunctionParamRole getRole()
       The parameter's syntactic role.
      .stardoc_output.FunctionParamRole role = 5;
      Returns:
      The role.