Interface PortDefinitionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PortDefinition, PortDefinition.Builder
@Generated public interface PortDefinitionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    PortType
    getAcceptedTypes(int index)
    For polymorphic ports, the list of accepted types.
    int
    getAcceptedTypesCount()
    For polymorphic ports, the list of accepted types.
    List<PortType>
    getAcceptedTypesList()
    For polymorphic ports, the list of accepted types.
    int
    getAcceptedTypesValue(int index)
    For polymorphic ports, the list of accepted types.
    List<Integer>
    getAcceptedTypesValueList()
    For polymorphic ports, the list of accepted types.
    String
    getDefaultValue()
    Default value for this port when not connected (JSON-encoded).
    com.google.protobuf.ByteString
    getDefaultValueBytes()
    Default value for this port when not connected (JSON-encoded).
    String
    getDescription()
    Optional description explaining what this port is for.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Optional description explaining what this port is for.
    String
    getDisplayName()
    Human-readable name displayed in the UI.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Human-readable name displayed in the UI.
    PortType
    getElementType()
    For list ports, the type of elements in the list.
    int
    getElementTypeValue()
    For list ports, the type of elements in the list.
    String
    getId()
    The identifier for this port.
    com.google.protobuf.ByteString
    getIdBytes()
    The identifier for this port.
    String
    getInferTypeFrom()
    For dynamic output ports, the ID of the input port to inherit type from.
    com.google.protobuf.ByteString
    getInferTypeFromBytes()
    For dynamic output ports, the ID of the input port to inherit type from.
    boolean
    getMultiInput()
    Whether this input accepts multiple connections (Blender-style multi-input).
    PortType
    getPortType()
    The data type this port accepts or produces.
    int
    getPortTypeValue()
    The data type this port accepts or produces.
    boolean
    getRequired()
    Whether this input is required for the node to execute.
    TypeDescriptor
    getTypeDescriptor()
    Optional generic type descriptor for parameterized types.
    TypeDescriptorOrBuilder
    getTypeDescriptorOrBuilder()
    Optional generic type descriptor for parameterized types.
    boolean
    hasDefaultValue()
    Default value for this port when not connected (JSON-encoded).
    boolean
    hasElementType()
    For list ports, the type of elements in the list.
    boolean
    hasTypeDescriptor()
    Optional generic type descriptor for parameterized types.

    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

    • getId

      String getId()
      The identifier for this port.
Used in edge connections (source_handle/target_handle).
Examples: "value", "target", "bot", "exec_in", "exec_out".
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
      The identifier for this port.
Used in edge connections (source_handle/target_handle).
Examples: "value", "target", "bot", "exec_in", "exec_out".
      string id = 1;
      Returns:
      The bytes for id.

    • getDisplayName

      String getDisplayName()
      Human-readable name displayed in the UI.
Examples: "Target Position", "Bot", "Message".
      string display_name = 2;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
      Human-readable name displayed in the UI.
Examples: "Target Position", "Bot", "Message".
      string display_name = 2;
      Returns:
      The bytes for displayName.

    • getPortTypeValue

      int getPortTypeValue()
      The data type this port accepts or produces.
      .soulfire.v1.PortType port_type = 3;
      Returns:
      The enum numeric value on the wire for portType.

    • getPortType

      PortType getPortType()
      The data type this port accepts or produces.
      .soulfire.v1.PortType port_type = 3;
      Returns:
      The portType.

    • getRequired

      boolean getRequired()
      Whether this input is required for the node to execute.
Only applicable for input ports.
      bool required = 4;
      Returns:
      The required.

    • hasDefaultValue

      boolean hasDefaultValue()
      Default value for this port when not connected (JSON-encoded).
Only applicable for input ports.
      optional string default_value = 5;
      Returns:
      Whether the defaultValue field is set.

    • getDefaultValue

      String getDefaultValue()
      Default value for this port when not connected (JSON-encoded).
Only applicable for input ports.
      optional string default_value = 5;
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      com.google.protobuf.ByteString getDefaultValueBytes()
      Default value for this port when not connected (JSON-encoded).
Only applicable for input ports.
      optional string default_value = 5;
      Returns:
      The bytes for defaultValue.

    • getDescription

      String getDescription()
      Optional description explaining what this port is for.
      string description = 6;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
      Optional description explaining what this port is for.
      string description = 6;
      Returns:
      The bytes for description.

    • hasElementType

      boolean hasElementType()
      For list ports, the type of elements in the list.
Only applicable when port_type is PORT_TYPE_LIST.
      optional .soulfire.v1.PortType element_type = 7;
      Returns:
      Whether the elementType field is set.

    • getElementTypeValue

      int getElementTypeValue()
      For list ports, the type of elements in the list.
Only applicable when port_type is PORT_TYPE_LIST.
      optional .soulfire.v1.PortType element_type = 7;
      Returns:
      The enum numeric value on the wire for elementType.

    • getElementType

      PortType getElementType()
      For list ports, the type of elements in the list.
Only applicable when port_type is PORT_TYPE_LIST.
      optional .soulfire.v1.PortType element_type = 7;
      Returns:
      The elementType.

    • getMultiInput

      boolean getMultiInput()
      Whether this input accepts multiple connections (Blender-style multi-input).
When true, all connected values are collected into a list.
Visually rendered as a pill/ellipsis shaped socket.
      bool multi_input = 8;
      Returns:
      The multiInput.

    • getAcceptedTypesList

      List<PortType> getAcceptedTypesList()
      For polymorphic ports, the list of accepted types.
If non-empty, this port can accept any of these types and will
adapt its behavior based on the connected type.
      repeated .soulfire.v1.PortType accepted_types = 9;
      Returns:
      A list containing the acceptedTypes.

    • getAcceptedTypesCount

      int getAcceptedTypesCount()
      For polymorphic ports, the list of accepted types.
If non-empty, this port can accept any of these types and will
adapt its behavior based on the connected type.
      repeated .soulfire.v1.PortType accepted_types = 9;
      Returns:
      The count of acceptedTypes.

    • getAcceptedTypes

      PortType getAcceptedTypes(int index)
      For polymorphic ports, the list of accepted types.
If non-empty, this port can accept any of these types and will
adapt its behavior based on the connected type.
      repeated .soulfire.v1.PortType accepted_types = 9;
      Parameters:
      index - The index of the element to return.
      Returns:
      The acceptedTypes at the given index.

    • getAcceptedTypesValueList

      List<Integer> getAcceptedTypesValueList()
      For polymorphic ports, the list of accepted types.
If non-empty, this port can accept any of these types and will
adapt its behavior based on the connected type.
      repeated .soulfire.v1.PortType accepted_types = 9;
      Returns:
      A list containing the enum numeric values on the wire for acceptedTypes.

    • getAcceptedTypesValue

      int getAcceptedTypesValue(int index)
      For polymorphic ports, the list of accepted types.
If non-empty, this port can accept any of these types and will
adapt its behavior based on the connected type.
      repeated .soulfire.v1.PortType accepted_types = 9;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of acceptedTypes at the given index.

    • getInferTypeFrom

      String getInferTypeFrom()
      For dynamic output ports, the ID of the input port to inherit type from.
Used for polymorphic nodes where output type depends on input type.
      string infer_type_from = 10;
      Returns:
      The inferTypeFrom.

    • getInferTypeFromBytes

      com.google.protobuf.ByteString getInferTypeFromBytes()
      For dynamic output ports, the ID of the input port to inherit type from.
Used for polymorphic nodes where output type depends on input type.
      string infer_type_from = 10;
      Returns:
      The bytes for inferTypeFrom.

    • hasTypeDescriptor

      boolean hasTypeDescriptor()
      Optional generic type descriptor for parameterized types.
When present, provides richer type information than the flat port_type field.
For example, List<Bot> or a type variable T that resolves from connections.
      optional .soulfire.v1.TypeDescriptor type_descriptor = 11;
      Returns:
      Whether the typeDescriptor field is set.

    • getTypeDescriptor

      TypeDescriptor getTypeDescriptor()
      Optional generic type descriptor for parameterized types.
When present, provides richer type information than the flat port_type field.
For example, List<Bot> or a type variable T that resolves from connections.
      optional .soulfire.v1.TypeDescriptor type_descriptor = 11;
      Returns:
      The typeDescriptor.

    • getTypeDescriptorOrBuilder

      TypeDescriptorOrBuilder getTypeDescriptorOrBuilder()
      Optional generic type descriptor for parameterized types.
When present, provides richer type information than the flat port_type field.
For example, List<Bot> or a type variable T that resolves from connections.
      optional .soulfire.v1.TypeDescriptor type_descriptor = 11;