Class PortDefinition

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.PortDefinition
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PortDefinitionOrBuilder, Serializable
@Generated public final class PortDefinition extends com.google.protobuf.GeneratedMessage implements PortDefinitionOrBuilder
Definition of a port (input or output) on a node type.
Describes the port's type, constraints, and display properties.
Protobuf type soulfire.v1.PortDefinition
See Also:

  • Field Details

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • PORT_TYPE_FIELD_NUMBER

      public static final int PORT_TYPE_FIELD_NUMBER
      See Also:

    • REQUIRED_FIELD_NUMBER

      public static final int REQUIRED_FIELD_NUMBER
      See Also:

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • ELEMENT_TYPE_FIELD_NUMBER

      public static final int ELEMENT_TYPE_FIELD_NUMBER
      See Also:

    • MULTI_INPUT_FIELD_NUMBER

      public static final int MULTI_INPUT_FIELD_NUMBER
      See Also:

    • ACCEPTED_TYPES_FIELD_NUMBER

      public static final int ACCEPTED_TYPES_FIELD_NUMBER
      See Also:

    • INFER_TYPE_FROM_FIELD_NUMBER

      public static final int INFER_TYPE_FROM_FIELD_NUMBER
      See Also:

    • TYPE_DESCRIPTOR_FIELD_NUMBER

      public static final int TYPE_DESCRIPTOR_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getId

      public 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;
      Specified by:
      getId in interface PortDefinitionOrBuilder
      Returns:
      The id.

    • getIdBytes

      public 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;
      Specified by:
      getIdBytes in interface PortDefinitionOrBuilder
      Returns:
      The bytes for id.

    • getDisplayName

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

    • getDisplayNameBytes

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

    • getPortTypeValue

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

    • getPortType

      public PortType getPortType()
      The data type this port accepts or produces.
      .soulfire.v1.PortType port_type = 3;
      Specified by:
      getPortType in interface PortDefinitionOrBuilder
      Returns:
      The portType.

    • getRequired

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

    • hasDefaultValue

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

    • getDefaultValue

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

    • getDefaultValueBytes

      public 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;
      Specified by:
      getDefaultValueBytes in interface PortDefinitionOrBuilder
      Returns:
      The bytes for defaultValue.

    • getDescription

      public String getDescription()
      Optional description explaining what this port is for.
      string description = 6;
      Specified by:
      getDescription in interface PortDefinitionOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

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

    • hasElementType

      public 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;
      Specified by:
      hasElementType in interface PortDefinitionOrBuilder
      Returns:
      Whether the elementType field is set.

    • getElementTypeValue

      public 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;
      Specified by:
      getElementTypeValue in interface PortDefinitionOrBuilder
      Returns:
      The enum numeric value on the wire for elementType.

    • getElementType

      public 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;
      Specified by:
      getElementType in interface PortDefinitionOrBuilder
      Returns:
      The elementType.

    • getMultiInput

      public 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;
      Specified by:
      getMultiInput in interface PortDefinitionOrBuilder
      Returns:
      The multiInput.

    • getAcceptedTypesList

      public 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;
      Specified by:
      getAcceptedTypesList in interface PortDefinitionOrBuilder
      Returns:
      A list containing the acceptedTypes.

    • getAcceptedTypesCount

      public 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;
      Specified by:
      getAcceptedTypesCount in interface PortDefinitionOrBuilder
      Returns:
      The count of acceptedTypes.

    • getAcceptedTypes

      public 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;
      Specified by:
      getAcceptedTypes in interface PortDefinitionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The acceptedTypes at the given index.

    • getAcceptedTypesValueList

      public 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;
      Specified by:
      getAcceptedTypesValueList in interface PortDefinitionOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for acceptedTypes.

    • getAcceptedTypesValue

      public 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;
      Specified by:
      getAcceptedTypesValue in interface PortDefinitionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of acceptedTypes at the given index.

    • getInferTypeFrom

      public 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;
      Specified by:
      getInferTypeFrom in interface PortDefinitionOrBuilder
      Returns:
      The inferTypeFrom.

    • getInferTypeFromBytes

      public 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;
      Specified by:
      getInferTypeFromBytes in interface PortDefinitionOrBuilder
      Returns:
      The bytes for inferTypeFrom.

    • hasTypeDescriptor

      public 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;
      Specified by:
      hasTypeDescriptor in interface PortDefinitionOrBuilder
      Returns:
      Whether the typeDescriptor field is set.

    • getTypeDescriptor

      public 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;
      Specified by:
      getTypeDescriptor in interface PortDefinitionOrBuilder
      Returns:
      The typeDescriptor.

    • getTypeDescriptorOrBuilder

      public 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;
      Specified by:
      getTypeDescriptorOrBuilder in interface PortDefinitionOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PortDefinition parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PortDefinition parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PortDefinition parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PortDefinition parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PortDefinition parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PortDefinition parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PortDefinition parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PortDefinition parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PortDefinition parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PortDefinition parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PortDefinition parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PortDefinition parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PortDefinition.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PortDefinition.Builder newBuilder()

    • newBuilder

      public static PortDefinition.Builder newBuilder(PortDefinition prototype)

    • toBuilder

      public PortDefinition.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PortDefinition.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PortDefinition getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PortDefinition> parser()

    • getParserForType

      public com.google.protobuf.Parser<PortDefinition> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PortDefinition getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder