ConnectableDTO (nifi-client-dto 1.23.2 API)

java.lang.Object
- org.apache.nifi.web.api.dto.ConnectableDTO

public class ConnectableDTO
extends Object

Details about a connectable component.

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`comments`
`private Boolean`	`exists`
`private String`	`groupId`
`private String`	`id`
`private String`	`name`
`private Boolean`	`running`
`private Boolean`	`transmitting`
`private String`	`type`
`private String`	`versionedComponentId`

Constructor Summary

Constructors
Constructor and Description

ConnectableDTO()

Constructors
Constructor and Description
`ConnectableDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getComments()`
`Boolean`	`getExists()`
`String`	`getGroupId()`
`String`	`getId()`
`String`	`getName()`
`Boolean`	`getTransmitting()`
`String`	`getType()`
`String`	`getVersionedComponentId()`
`Boolean`	`isRunning()`
`void`	`setComments(String comments)`
`void`	`setExists(Boolean exists)`
`void`	`setGroupId(String groupId)`
`void`	`setId(String id)`
`void`	`setName(String name)`
`void`	`setRunning(Boolean running)`
`void`	`setTransmitting(Boolean transmitting)`
`void`	`setType(String type)`
`void`	`setVersionedComponentId(String id)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id
```
private String id
```

versionedComponentId
```
private String versionedComponentId
```

type
```
private String type
```

groupId
```
private String groupId
```

name
```
private String name
```

running
```
private Boolean running
```

transmitting
```
private Boolean transmitting
```

exists
```
private Boolean exists
```

comments
```
private String comments
```

Constructor Detail
- ConnectableDTO
```
public ConnectableDTO()
```

Method Detail
- getId
```
public String getId()
```
  Returns:
  
  id of this connectable component
- setId
```
public void setId(String id)
```
- getVersionedComponentId
```
public String getVersionedComponentId()
```
- setVersionedComponentId
```
public void setVersionedComponentId(String id)
```
- getType
```
public String getType()
```
  Returns:
  
  type of this connectable component
- setType
```
public void setType(String type)
```
- getGroupId
```
public String getGroupId()
```
  Returns:
  
  id of the group that this connectable component resides in
- setGroupId
```
public void setGroupId(String groupId)
```
- getName
```
public String getName()
```
  Returns:
  
  name of this connectable component
- setName
```
public void setName(String name)
```
- isRunning
```
public Boolean isRunning()
```
  Returns:
  
  Used to reflect the current state of this Connectable
- setRunning
```
public void setRunning(Boolean running)
```
- getExists
```
public Boolean getExists()
```
  Returns:
  
  If this represents a remote port it is used to indicate whether the target exists
- setExists
```
public void setExists(Boolean exists)
```
- getTransmitting
```
public Boolean getTransmitting()
```
  Returns:
  
  If this represents a remote port it is used to indicate whether is it configured to transmit
- setTransmitting
```
public void setTransmitting(Boolean transmitting)
```
- getComments
```
public String getComments()
```
  Returns:
  
  The comments from this Connectable
- setComments
```
public void setComments(String comments)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class ConnectableDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

versionedComponentId

type

groupId

name

running

transmitting

exists

comments

Constructor Detail

ConnectableDTO

Method Detail

getId

setId

getVersionedComponentId

setVersionedComponentId

getType

setType

getGroupId

setGroupId

getName

setName

isRunning

setRunning

getExists

setExists

getTransmitting

setTransmitting

getComments

setComments

toString