Class PortDefinition.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<PortDefinition.Builder>
com.google.protobuf.GeneratedMessage.Builder<PortDefinition.Builder>
com.soulfiremc.grpc.generated.PortDefinition.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PortDefinitionOrBuilder, Cloneable
Enclosing class:
PortDefinition
public static final class PortDefinition.Builder extends com.google.protobuf.GeneratedMessage.Builder<PortDefinition.Builder> 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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PortDefinition.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PortDefinition.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public PortDefinition.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PortDefinition.Builder>

    • mergeFrom

      public PortDefinition.Builder mergeFrom(PortDefinition other)

    • isInitialized

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

    • mergeFrom

      public PortDefinition.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PortDefinition.Builder>
      Throws:
      IOException

    • 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.

    • setId

      public PortDefinition.Builder setId(String value)
      The identifier for this port.
Used in edge connections (source_handle/target_handle).
Examples: "value", "target", "bot", "exec_in", "exec_out".
      string id = 1;
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public PortDefinition.Builder clearId()
      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:
      This builder for chaining.

    • setIdBytes

      public PortDefinition.Builder setIdBytes(com.google.protobuf.ByteString value)
      The identifier for this port.
Used in edge connections (source_handle/target_handle).
Examples: "value", "target", "bot", "exec_in", "exec_out".
      string id = 1;
      Parameters:
      value - The bytes for id to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDisplayName

      public PortDefinition.Builder setDisplayName(String value)
      Human-readable name displayed in the UI.
Examples: "Target Position", "Bot", "Message".
      string display_name = 2;
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public PortDefinition.Builder clearDisplayName()
      Human-readable name displayed in the UI.
Examples: "Target Position", "Bot", "Message".
      string display_name = 2;
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public PortDefinition.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
      Human-readable name displayed in the UI.
Examples: "Target Position", "Bot", "Message".
      string display_name = 2;
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPortTypeValue

      public PortDefinition.Builder setPortTypeValue(int value)
      The data type this port accepts or produces.
      .soulfire.v1.PortType port_type = 3;
      Parameters:
      value - The enum numeric value on the wire for portType to set.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • 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.

    • setPortType

      public PortDefinition.Builder setPortType(PortType value)
      The data type this port accepts or produces.
      .soulfire.v1.PortType port_type = 3;
      Parameters:
      value - The portType to set.
      Returns:
      This builder for chaining.

    • clearPortType

      public PortDefinition.Builder clearPortType()
      The data type this port accepts or produces.
      .soulfire.v1.PortType port_type = 3;
      Returns:
      This builder for chaining.

    • 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.

    • setRequired

      public PortDefinition.Builder setRequired(boolean value)
      Whether this input is required for the node to execute.
Only applicable for input ports.
      bool required = 4;
      Parameters:
      value - The required to set.
      Returns:
      This builder for chaining.

    • clearRequired

      public PortDefinition.Builder clearRequired()
      Whether this input is required for the node to execute.
Only applicable for input ports.
      bool required = 4;
      Returns:
      This builder for chaining.

    • 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.

    • setDefaultValue

      public PortDefinition.Builder setDefaultValue(String value)
      Default value for this port when not connected (JSON-encoded).
Only applicable for input ports.
      optional string default_value = 5;
      Parameters:
      value - The defaultValue to set.
      Returns:
      This builder for chaining.

    • clearDefaultValue

      public PortDefinition.Builder clearDefaultValue()
      Default value for this port when not connected (JSON-encoded).
Only applicable for input ports.
      optional string default_value = 5;
      Returns:
      This builder for chaining.

    • setDefaultValueBytes

      public PortDefinition.Builder setDefaultValueBytes(com.google.protobuf.ByteString value)
      Default value for this port when not connected (JSON-encoded).
Only applicable for input ports.
      optional string default_value = 5;
      Parameters:
      value - The bytes for defaultValue to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDescription

      public PortDefinition.Builder setDescription(String value)
      Optional description explaining what this port is for.
      string description = 6;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public PortDefinition.Builder clearDescription()
      Optional description explaining what this port is for.
      string description = 6;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public PortDefinition.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
      Optional description explaining what this port is for.
      string description = 6;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • 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.

    • setElementTypeValue

      public PortDefinition.Builder setElementTypeValue(int value)
      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;
      Parameters:
      value - The enum numeric value on the wire for elementType to set.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • 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.

    • setElementType

      public PortDefinition.Builder setElementType(PortType value)
      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;
      Parameters:
      value - The elementType to set.
      Returns:
      This builder for chaining.

    • clearElementType

      public PortDefinition.Builder clearElementType()
      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:
      This builder for chaining.

    • 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.

    • setMultiInput

      public PortDefinition.Builder setMultiInput(boolean value)
      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;
      Parameters:
      value - The multiInput to set.
      Returns:
      This builder for chaining.

    • clearMultiInput

      public PortDefinition.Builder clearMultiInput()
      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:
      This builder for chaining.

    • 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.

    • setAcceptedTypes

      public PortDefinition.Builder setAcceptedTypes(int index, PortType value)
      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 to set the value at.
      value - The acceptedTypes to set.
      Returns:
      This builder for chaining.

    • addAcceptedTypes

      public PortDefinition.Builder addAcceptedTypes(PortType value)
      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:
      value - The acceptedTypes to add.
      Returns:
      This builder for chaining.

    • addAllAcceptedTypes

      public PortDefinition.Builder addAllAcceptedTypes(Iterable<? extends PortType> values)
      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:
      values - The acceptedTypes to add.
      Returns:
      This builder for chaining.

    • clearAcceptedTypes

      public PortDefinition.Builder clearAcceptedTypes()
      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:
      This builder for chaining.

    • 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.

    • setAcceptedTypesValue

      public PortDefinition.Builder setAcceptedTypesValue(int index, int value)
      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 to set the value at.
      value - The enum numeric value on the wire for acceptedTypes to set.
      Returns:
      This builder for chaining.

    • addAcceptedTypesValue

      public PortDefinition.Builder addAcceptedTypesValue(int value)
      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:
      value - The enum numeric value on the wire for acceptedTypes to add.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • addAllAcceptedTypesValue

      public PortDefinition.Builder addAllAcceptedTypesValue(Iterable<Integer> values)
      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:
      values - The enum numeric values on the wire for acceptedTypes to add.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • 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.

    • setInferTypeFrom

      public PortDefinition.Builder setInferTypeFrom(String value)
      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;
      Parameters:
      value - The inferTypeFrom to set.
      Returns:
      This builder for chaining.

    • clearInferTypeFrom

      public PortDefinition.Builder clearInferTypeFrom()
      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:
      This builder for chaining.

    • setInferTypeFromBytes

      public PortDefinition.Builder setInferTypeFromBytes(com.google.protobuf.ByteString value)
      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;
      Parameters:
      value - The bytes for inferTypeFrom to set.
      Returns:
      This builder for chaining.

    • 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.

    • setTypeDescriptor

      public PortDefinition.Builder setTypeDescriptor(TypeDescriptor value)
      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;

    • setTypeDescriptor

      public PortDefinition.Builder setTypeDescriptor(TypeDescriptor.Builder builderForValue)
      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;

    • mergeTypeDescriptor

      public PortDefinition.Builder mergeTypeDescriptor(TypeDescriptor value)
      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;

    • clearTypeDescriptor

      public PortDefinition.Builder clearTypeDescriptor()
      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;

    • getTypeDescriptorBuilder

      public TypeDescriptor.Builder getTypeDescriptorBuilder()
      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;

    • 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