AGSUtilityNamedTraceConfiguration Class Reference

Description

A set of predefined trace options that can be used by the AGSUtilityTraceParameters object to simplify configuring and running a trace operation. Named trace configurations are created in the utility network and allows clients to perform trace analytics without needing to understand the data model. Applications can simply allow the user to choose from a set of named trace configurations that provide tracing capabilities. The set can be configured for different workflows, and a single application can be used by multiple customers and across multiple problem domains.

See also

- namedTraceConfigurationsFromUtilityNetwork:completion: (AGSMap), - queryNamedTraceConfigurationsWithQueryParameters:completion: (AGSUtilityNetwork)

Since

100.11

Inheritance diagram for AGSUtilityNamedTraceConfiguration:

Instance Methods
(AGSUtilityTraceConfiguration *)	- makeDefaultTraceConfiguration

Properties
NSString *	creator
NSUUID *	globalID
AGSUtilityMinimumStartingLocations	minimumStartingLocations
NSString *	name
NSArray< NSValue * > *	resultTypes
NSString *	serviceDescription
NSArray< NSString * > *	tags
AGSUtilityTraceConfiguration *	traceConfiguration
AGSUtilityTraceType	traceType

Method Documentation

makeDefaultTraceConfiguration

- (AGSUtilityTraceConfiguration *) makeDefaultTraceConfiguration

Creates an instance of AGSUtilityTraceConfiguration for this AGSUtilityNamedTraceConfiguration.

Returns

A new AGSUtilityTraceConfiguration object.

Since

100.12

Property Documentation

creator

- (NSString*) creator

readnonatomiccopy

The creator of the named trace configuration. The creator will be the active portal user when the named trace configuration was created.

Since

100.11

globalID

- (NSUUID*) globalID

readnonatomicstrong

The global ID of the named trace configuration.

Since

100.11

minimumStartingLocations

- (AGSUtilityMinimumStartingLocations) minimumStartingLocations

readnonatomicassign

The minimum number of starting locations required for this trace type (e.g. shortest path trace requires 2).

See also

AGSUtilityMinimumStartingLocations

Since

100.11

name

- (NSString*) name

readnonatomiccopy

The name of the named trace configuration.

Since

100.11

resultTypes

- (NSArray<NSValue *>*) resultTypes

readnonatomiccopy

The result types returned by this named trace configuration.

See also

AGSUtilityTraceResultType

Since

100.11

serviceDescription

- (NSString*) serviceDescription

readnonatomiccopy

The description of the named trace configuration.

Since

100.11

tags

- (NSArray<NSString *>*) tags

readnonatomiccopy

The user tags of the named trace configuration.

Since

100.11

traceConfiguration

- (AGSUtilityTraceConfiguration*) traceConfiguration

readnonatomicstrong

The AGSUtilityTraceConfiguration defined for this AGSUtilityNamedTraceConfiguration.

This AGSUtilityTraceConfiguration defines the AGSUtilityNamedTraceConfiguration and cannot be modified.

Since

100.11

Deprecated:

100.12. Use makeDefaultTraceConfiguration instead to create an instance of AGSUtilityTraceConfiguration for this AGSUtilityNamedTraceConfiguration.

Provided by category AGSUtilityNamedTraceConfiguration(AGSDeprecated).

traceType

- (AGSUtilityTraceType) traceType

readnonatomicassign

The AGSUtilityTraceType used by the named trace configuration.

See also

AGSUtilityTraceType

Since

100.11