Package org.apache.nifi.api.toolkit.model

Class PortDTO

java.lang.Object
org.apache.nifi.api.toolkit.model.PortDTO
@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen", date="2023-11-22T19:25:26.907436939-06:00[America/Chicago]") public class PortDTO extends Object
PortDTO

  • Field Details

  • Constructor Details

    • PortDTO

      public PortDTO()

  • Method Details

    • id

      public PortDTO id(String id)

    • getId

      public String getId()
      The id of the component.
      Returns:
      id

    • setId

      public void setId(String id)

    • versionedComponentId

      public PortDTO versionedComponentId(String versionedComponentId)

    • getVersionedComponentId

      public String getVersionedComponentId()
      The ID of the corresponding component that is under version control
      Returns:
      versionedComponentId

    • setVersionedComponentId

      public void setVersionedComponentId(String versionedComponentId)

    • parentGroupId

      public PortDTO parentGroupId(String parentGroupId)

    • getParentGroupId

      public String getParentGroupId()
      The id of parent process group of this component if applicable.
      Returns:
      parentGroupId

    • setParentGroupId

      public void setParentGroupId(String parentGroupId)

    • position

      public PortDTO position(PositionDTO position)

    • getPosition

      public PositionDTO getPosition()
      Get position
      Returns:
      position

    • setPosition

      public void setPosition(PositionDTO position)

    • name

      public PortDTO name(String name)

    • getName

      public String getName()
      The name of the port.
      Returns:
      name

    • setName

      public void setName(String name)

    • comments

      public PortDTO comments(String comments)

    • getComments

      public String getComments()
      The comments for the port.
      Returns:
      comments

    • setComments

      public void setComments(String comments)

    • state

      public PortDTO state(PortDTO.StateEnum state)

    • getState

      public PortDTO.StateEnum getState()
      The state of the port.
      Returns:
      state

    • setState

      public void setState(PortDTO.StateEnum state)

    • type

      public PortDTO type(PortDTO.TypeEnum type)

    • getType

      public PortDTO.TypeEnum getType()
      The type of port.
      Returns:
      type

    • setType

      public void setType(PortDTO.TypeEnum type)

    • transmitting

      public PortDTO transmitting(Boolean transmitting)

    • isTransmitting

      public Boolean isTransmitting()
      Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely.
      Returns:
      transmitting

    • setTransmitting

      public void setTransmitting(Boolean transmitting)

    • concurrentlySchedulableTaskCount

      public PortDTO concurrentlySchedulableTaskCount(Integer concurrentlySchedulableTaskCount)

    • getConcurrentlySchedulableTaskCount

      public Integer getConcurrentlySchedulableTaskCount()
      The number of tasks that should be concurrently scheduled for the port.
      Returns:
      concurrentlySchedulableTaskCount

    • setConcurrentlySchedulableTaskCount

      public void setConcurrentlySchedulableTaskCount(Integer concurrentlySchedulableTaskCount)

    • allowRemoteAccess

      public PortDTO allowRemoteAccess(Boolean allowRemoteAccess)

    • isAllowRemoteAccess

      public Boolean isAllowRemoteAccess()
      Whether this port can be accessed remotely via Site-to-Site protocol.
      Returns:
      allowRemoteAccess

    • setAllowRemoteAccess

      public void setAllowRemoteAccess(Boolean allowRemoteAccess)

    • portFunction

      public PortDTO portFunction(PortDTO.PortFunctionEnum portFunction)

    • getPortFunction

      public PortDTO.PortFunctionEnum getPortFunction()
      Specifies how the Port functions
      Returns:
      portFunction

    • setPortFunction

      public void setPortFunction(PortDTO.PortFunctionEnum portFunction)

    • validationErrors

      public PortDTO validationErrors(List<String> validationErrors)

    • addValidationErrorsItem

      public PortDTO addValidationErrorsItem(String validationErrorsItem)

    • getValidationErrors

      public List<String> getValidationErrors()
      Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.
      Returns:
      validationErrors

    • setValidationErrors

      public void setValidationErrors(List<String> validationErrors)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toIndentedString

      private String toIndentedString(Object o)
      Convert the given object to string with each line indented by 4 spaces (except the first line).