Summary
The properties below are returned by the updateSubnetworkTraceConfiguration object when using Describe on a utility network.
These properties describe the trace configuration used when a subnetwork is updated.
Properties
| Property | Explanation | Data Type |
| conditionBarriers (Read Only) | The conditionBarriers object. This object can be used to retrieve properties of the condition barriers set for the trace configuration. | Object |
| diagramTemplateName (Read Only) | The name of the diagram template name used for the trace configuration. | String |
| domainNetworkName (Read Only) | The name of the domain network. | String |
| filterBarriers (Read Only) | The filterBarriers object. This object can be used to retrieve properties of the filter barriers set for the trace configuration. | Object |
| filterBitsetNetworkAttributeName (Read Only) | The name of the network attribute that can be used to filter by bitset. | String |
| filterFunctionBarriers (Read Only) | The filterFunctionBarriers object. This object can be used to retrieve properties of the filter function barriers set for the trace configuration. | Object |
| filterScope (Read Only) | The traversability that is enforced for a specific category. For example, both junctions and edges, junctions only, or edges only. | String |
| functionBarriers (Read Only) | The functionBarriers object. This object can be used to retrieve properties of the function barriers set for the trace configuration. | Object |
| functions (Read Only) | The functions object. This object can be used to retrieve properties of the functions set for the trace configuration. | Object |
| includeBarriers (Read Only) | Whether or not the trace is configured to include barrier features in the trace results.
| Boolean |
| includeContainers (Read Only) | Whether or not the trace is configured to include container features in the trace results.
| Boolean |
| includeContent (Read Only) | Whether or not the trace is configured to include content in containers in the trace results.
| Boolean |
| includeStructures (Read Only) | Whether or not the trace is configured to include structure features in the trace results.
| Boolean |
| nearestNeighbor (Read Only) | The nearestNeighbor object. This object can be used to retrieve properties of the nearest neighbor set for the trace configuration. | Object |
| outputConditions (Read Only) | The outputConditions object. This object can be used to retrieve properties of the output conditions set for the trace configuration. | Object |
| outputFilters (Read Only) | The outputFilters object. This object can be used to retrieve properties of the output filters set for the trace configuration. | Object |
| propagators (Read Only) | The propagators object. This object can be used to retrieve properties of the propagators set for the trace configuration. | Object |
| shortestPathNetworkAttributeName (Read Only) | The name of the network attribute used to calculate the shortest path. | String |
| targetTierName (Read Only) | The name of the target tier for which the starting tier flows toward. | String |
| tierName (Read Only) | The name of the tier to start the trace. | String |
| traversabilityScope (Read Only) | The traversability that is enforced. For example, both junctions and edges, junctions only, or edges only. | String |
| validateConsistency (Read Only) | Whether or not the trace is configured to validate consistency in trace results.
| Boolean |