package
8.0.2
Repository: https://github.com/apache/trafficcontrol.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
Package tovalidate contains helpful utility functions and ozzo-validator-compatible rules and rule generators for validating data in the Traffic Ops API.

# Functions

CacheStatusFromString returns a CacheStatus from its string representation, or CacheStatusInvalid if the string is not a valid CacheStatus.
CacheTypeFromString returns a CacheType structure from its string representation, or CacheTypeInvalid if the string is not a valid CacheType.
CDNExistsByName returns whether a cdn with the given name exists, and any error.
CreateAlerts creates and returns an Alerts structure filled with "Alert"s that are all of the provided level, each having one of messages as text in turn.
CreateErrorAlerts creates and returns an Alerts structure filled with ErrorLevel-level "Alert"s using the errors to provide text.
CRStatesMarshall serializes the given CRStates into bytes.
CRStatesUnMarshall takes bytes of a JSON string, and unmarshals them into a CRStates object.
DeepCachingTypeFromString returns a DeepCachingType from its string representation, or DeepCachingTypeInvalid if the string is not a valid DeepCachingTypeFromString.
DSMatchTypeFromString returns a DSMatchType from its string representation, or DSMatchTypeInvalid if the string is not a valid type.
DSRChangeTypeFromString converts the passed string to a DSRChangeType (case-insensitive), returning an error if the string is not a valid Delivery Service Request Change Type.
DSTypeCategoryFromString returns a DSTypeCategory from its string representation, or DSTypeCategoryInvalid if the string is not a valid DSTypeCategory.
DSTypeFromString returns a DSType from its string representation, or DSTypeInvalid if the string is not a valid DSType.
DurationLiteralToSeconds returns the number of seconds to which an InfluxQL duration literal is equivalent.
ExcludeFromString parses the passed string and returns the corresponding value as a TrafficStatsExclude.
FederationResolverTypeFromString parses a string and returns the corresponding FederationResolverType.
FormatForResponse converts a CacheGroupParametersNullable to CacheGroupParametersResponseNullable in order to format the output the same as the Perl endpoint.
GetDSTypeCategory returns the delivery service type category (either HTTP or DNS) of the given delivery service type.
No description provided by the author
GetTypeData returns the type's name and use_in_table, true/false if the query returned data, and any error.
GetVIPInterface returns the primary interface specified by the `Monitor` property of an Interface.
InterfaceInfoToLegacyInterfaces converts a ServerInterfaceInfo to an equivalent LegacyInterfaceDetails structure.
IsReservedStatus returns true if the passed in status name is reserved, and false if it isn't.
IsValidCacheType returns true if the given string represents a valid cache type.
LegacyMonitorConfigValid checks the validity of the passed LegacyTrafficMonitorConfigMap, returning an error if it is invalid.
LegacyTrafficMonitorTransformToMap converts the given LegacyTrafficMonitorConfig to a LegacyTrafficMonitorConfigMap.
LocalizationMethodFromString parses and returns a LocalizationMethod from its string representation.
MessagesToString converts a set of messages from an InfluxDB node into a single, print-able string.
NewCRStates creates a new CR states object, initializing pointer members.
NewTimeNoMod returns the address of a TimeNoMod with a Time value of the current time.
OrderableFromString parses the passed string and returns the corresponding value as a pointer to a TrafficStatsOrderable - or nil if the value was invalid.
ParamExists returns whether a parameter with the given id exists, and any error.
ParamsExist returns whether parameters exist for all the given ids, and any error.
ProfileExistsByID returns whether a profile with the given id exists, and any error.
ProfileExistsByName returns whether a profile with the given name exists, and any error.
ProfilesExistByIDs returns whether profiles exist for all the given ids, and any error.
ProtocolFromString parses a string and returns the corresponding Protocol.
RequestStatusFromString gets the status enumeration from a string.
SteeringTypeFromString parses a string to return the corresponding SteeringType.
StrToThreshold takes a string like ">=42" and returns a HealthThreshold with a Val of `42` and a Comparator of `">="`.
TimeNoModFromTime returns a reference to a TimeNoMod with the given Time value.
ToInterfacesV4 upgrades server interfaces from their APIv3 representation to an APIv4 representation.
TrafficMonitorTransformToMap converts the given TrafficMonitorConfig to a TrafficMonitorConfigMap.
UpdateServerPropertiesV40 updates CommonServerProperties of V2 and V3 to ServerV40.
UpgradeToFederationResolverV5 upgrades an APIv4 Federal Resolver into an APIv5 Federal Resolver of the latest minor version.
V4InterfaceInfoToLegacyInterfaces downgrades a set of ServerInterfaceInfoV40s to a LegacyInterfaceDetails.
V4InterfaceInfoToV3Interfaces downgrades a set of ServerInterfaceInfoV40s to ServerInterfaceInfos.
ValidateJobUniqueness returns a message describing each overlap between existing content invalidation jobs for the same assetURL as the one passed.
ValidateTypeID validates that the typeID references a type with the expected use_in_table string and returns "" and an error if the typeID is invalid.

# Constants

AdminRoleName is the Name of the special "admin" Role.
AlgorithmConsistentHash is the name of the Multi-Site Origin hashing algorithm that performs consistent hashing on a set of parents.
Enumerated values of the Filter type.
CachegroupCoordinateNamePrefix is a string that all cache group coordinate names are prefixed with.
These are the Names of the Types that must be used by various kinds of Cache Groups to ensure proper behavior.
These are the Names of the Types that must be used by various kinds of Cache Groups to ensure proper behavior.
These are the Names of the Types that must be used by various kinds of Cache Groups to ensure proper behavior.
These are the valid values for the Type property of a Profile.
CacheStatusAdminDown represents a cache server which has been administratively marked as "down", but which should still appear in the CDN.
CacheStatusInvalid represents an unrecognized Status value.
CacheStatusOffline represents a cache server which should always be considered offline/unavailable/unhealthy, irrespective of monitoring.
CacheStatusOnline represents a cache server which should always be considered online/available/healthy, irrespective of monitoring.
CacheStatusPreProd represents a cache server that is not deployed to "production", but is ready for it.
CacheStatusReported represents a cache server which is polled for health by Traffic Monitor.
CacheTypeEdge represents an edge-tier cache server.
CacheTypeInvalid represents an CacheType.
CacheTypeMid represents a mid-tier cache server.
Authentication methods used for signing Delivery Service SSL certificates.
CoverageZonePollingPrefix is the prefix of all Names of Parameters used to define coverage zone polling parameters.
No description provided by the author
No description provided by the author
No description provided by the author
These are the allowable values of a DeepCachingType.
These are the allowable values of a DeepCachingType.
default value.
DefaultHealthThresholdComparator is the comparator used for health thresholds when one is not explicitly provided in the Value of a Parameter used to define a Threshold.
DefaultMaxRequestHeaderBytes is the Max Header Bytes given to Delivery Services upon creation through the Traffic Ops API if Max Request Header Bytes is not specified in the request body.
DefaultRoutingName is the Routing Name given to Delivery Services upon creation through the Traffic Ops API if a Routing Name is not specified in the request body.
These are the valid values for the Type property of a Profile.
The various allowable statuses for DNSSEC keys being inserted into or retrieved from Traffic Vault.
The various allowable statuses for DNSSEC keys being inserted into or retrieved from Traffic Vault.
Key-signing key.
The various allowable statuses for DNSSEC keys being inserted into or retrieved from Traffic Vault.
Zone-signing key.
Traffic Router routes clients for this Delivery Service and cache servers are configured to serve its content.
Traffic Router does not route for this Delivery Service and cache servers cannot serve its content.
Traffic Router does not route for this Delivery Service, but cache servers are configured to serve its content.
These are the allowed values for a DSMatchType.
These are the allowed values for a DSMatchType.
These are the allowed values for a DSMatchType.
These are the allowed values for a DSMatchType.
These are the allowed values for a DSMatchType.
Indicates content will only be served using the unsecured HTTP Protocol.
Indicates content will only be served over both HTTP and HTTPS.
Indicates content will only be served using the secured HTTPS Protocol.
Indicates content will only be served using the secured HTTPS Protocol, and that unsecured HTTP requests will be directed to use HTTPS instead.
The requested Delivery Service is being created.
The requested Delivery Service is being deleted.
The original Delivery Service is being modified to match the requested one.
These are the allowable values for a DSType.
DSTypeCategoryDNS represents a DNS-routed Delivery Service.
DSTypeCategoryHTTP represents an HTTP-routed Delivery Service.
DSTypeCategoryInvalid represents an invalid Delivery Service routing type.
These are the allowable values for a DSType.
These are the allowable values for a DSType.
These are the allowable values for a DSType.
These are the allowable values for a DSType.
These are the allowable values for a DSType.
These are the allowable values for a DSType.
These are the allowable values for a DSType.
These are the allowable values for a DSType.
These are the allowable values for a DSType.
DSTypeLiveNationalSuffix is the suffix that Delivery Services which are both "live" and "national" MUST have at the end of the Name(s) of the Type(s) they use in order to be treated properly by ATC.
DSTypeLiveSuffix is the suffix that Delivery Services which are "live" - but not "national" (maybe?) - MUST have at the end of the Name(s) of the Type(s) they use in order to be treated properly by ATC.
These are the allowable values for a DSType.
EdgeTypePrefix is a prefix which MUST appear on the Names of Types used by edge-tier cache servers in order for them to be recognized as edge-tier cache servers by ATC.
These are the valid values for the Type property of a Profile.
Enumerated values of the Filter type.
EmptyAddressCannotBeAServiceAddressError is the client-facing error returned from the Traffic Ops API's /servers endpoint when the client is attempting to update or create a server that has an IP address marked as the "service address" which was not provided in the request (although the other address family address may have been provided).
ErrorLevel indicates that the request failed.
ExcludeInvalid can be used if the the key that you want to exclude fails validation.
ExcludeSeries can be used to omit the data series from a response.
ExcludeSummary can be used to omit the summary series from a response.
These are the allowable values of a FederationResolverType.
These are the allowable values of a FederationResolverType.
These are the allowable values of a FederationResolverType.
GlobalConfigFileName is ConfigFile value which can cause a Parameter to be handled specially by Traffic Control components under certain circumstances.
GlobalProfileName is the Name of a Profile that is treated specially in some respects by some components of ATC.
These are the valid values for the Type property of a Profile.
These are the valid values for the Type property of a Profile.
InfoLevel indicates that the message is supplementary and is not directly the result of the user's request.
JobRequestTimeFormat is a Go reference time format, for use with time.Format, of the format used by the Perl version of the /jobs and /user/current/jobs endpoints.
JobTimeFormat is a Go reference time format, for use with time.Format.
These are the valid values for the Type property of a Profile.
Authentication methods used for signing Delivery Service SSL certificates.
These are the allowable values of a LocalizationMethod.
These are the allowable values of a LocalizationMethod.
These are the allowable values of a LocalizationMethod.
These are the allowable values of a LocalizationMethod.
These are the valid values for the Type property of a Profile.
MaxRangeSliceBlockSize is the maximum allowed value for a Delivery Service's Range Slice Block Size, in bytes.
MaxTTL is the maximum value of TTL representable as a time.Duration object, which is used internally by InvalidationJobInput objects to store the TTL.
MidTypePrefix is a prefix which MUST appear on the Names of Types used by mid-tier cache servers in order for them to be recognized as mid-tier cache servers by ATC.
MinRangeSliceBlockSize is the minimum allowed value for a Delivery Service's Range Slice Block Size, in bytes.
MonitorProfilePrefix is a prefix which MUST appear on the Names of Profiles used by Traffic Monitor instances as servers in Traffic Ops, or they may not be treated properly.
MonitorTypeName is the Name of the Type which must be assigned to a server for it to be treated as a Traffic Monitor instance by ATC.
NeedsAtLeastOneIPError is the client-facing error returned from the Traffic Ops API's /servers endpoint when the client is attempting to update or create a server without an IPv4 or IPv6 address.
NeedsAtLeastOneServiceAddressError is the client-facing error returned from the Traffic Ops API's /servers endpoint when the client is attempting to update or create a server without an IP address marked as its "service address".
NilTenantError can used when a Tenantable object finds that TentantID in the request is nil.
OriginLocationType is the Name of a Cache Group which represents an "Origin Location".
These are the valid values for the Type property of a Profile.
OriginTypeName is the Name of the Type which must be assigned to a server for it to be treated as an Origin server by ATC.
PermCDNLocksDeleteOthers is a string representing the permission to be able to delete other users' CDN locks.
PermICDNUCDNOverride is a string representing the permission to be able to override the ucdn parameter.
PermParameterSecureRead is a string representing the permission to be able to read secure parameters.
PermSecureServerRead is a string representing the permission to be able to read secure server properties.
ProtocolHTTP represents the HTTP/1.1 protocol as specified in RFC2616.
ProtocolHTTPandHTTPS represents the use of both HTTP and HTTPS.
ProtocolHTTPS represents the HTTP/1.1 protocol over a TCP connection secured by TLS.
ProtocolHTTPtoHTTPS represents a redirection of unsecured HTTP requests to HTTPS.
ProtocolInvalid represents an invalid Protocol.
These are the allowable values for a QStringIgnore.
These are the allowable values for a QStringIgnore.
These are the allowable values for a QStringIgnore.
The allowed values for a Delivery Service's Query String Handling.
The allowed values for a Delivery Service's Query String Handling.
The allowed values for a Delivery Service's Query String Handling.
The allowed values for a Delivery Service's Range Request Handling.
The allowed values for a Delivery Service's Range Request Handling.
The allowed values for a Delivery Service's Range Request Handling.
The allowed values for a Delivery Service's Range Request Handling.
These are the allowed values for the InvalidationType of an InvalidationJobCreateV4/InvalidationJobV4.
RefetchEnabled is the name of a Parameter used to determine if the Refetch feature is enabled.
These are the allowed values for the InvalidationType of an InvalidationJobCreateV4/InvalidationJobV4.
The DSR has been approved and fully implemented.
The DSR is a draft that is not ready for review.
The state as parsed from a raw string did not represent a valid RequestStatus.
The DSR has been approved by a reviewer and is pending fullfillment.
The DSR was rejected by a reviewer.
The DSR has been submitted for review.
These names of URL query string parameters are not allowed to be in a Delivery Service's "ConsistentHashQueryParams" set, because they collide with query string parameters reserved for use by Traffic Router.
These names of URL query string parameters are not allowed to be in a Delivery Service's "ConsistentHashQueryParams" set, because they collide with query string parameters reserved for use by Traffic Router.
These names of URL query string parameters are not allowed to be in a Delivery Service's "ConsistentHashQueryParams" set, because they collide with query string parameters reserved for use by Traffic Router.
RiakProfileType is the type of a Profile used on the legacy RiakKV system which used to be used as a back-end for Traffic Vault.
RouterTypeName is the Name of the Type which must be assigned to a server for it to be treated as a Traffic Router instance by ATC.
Authentication methods used for signing Delivery Service SSL certificates.
These are the allowable values for the Signing Algorithm property of a Delivery Service.
These are the allowable values for the Signing Algorithm property of a Delivery Service.
These are the valid values for the Type property of a Profile.
These are the names of statistics that can be used in thresholds for server health.
These are the names of statistics that can be used in thresholds for server health.
These are the names of statistics that can be used in thresholds for server health.
These are the allowable values of a SteeringType.
These are the allowable values of a SteeringType.
These are the allowable values of a SteeringType.
These are the allowable values of a SteeringType.
These are the allowable values of a SteeringType.
SuccessLevel indicates that an action is successful.
TenantDSUserNotAuthError is used when a user does not have access to a requested resource tenant for a delivery service.
TenantUserNotAuthError is used when a user does not have access to a requested resource tenant.
ThresholdPrefix is the prefix of all Names of Parameters used to define monitoring thresholds.
TimeLayout is the format used in lastUpdated fields in Traffic Ops.
TimeOrder indicates an ordering by time at which the measurement was taken.
Deprecated: TLS version 1.0 is known to be insecure.
Deprecated: TLS version 1.1 is known to be insecure.
These are the TLS Versions known by Apache Traffic Control to exist.
These are the TLS Versions known by Apache Traffic Control to exist.
These are the valid values for the Type property of a Profile.
These are the valid values for the Type property of a Profile.
These are the valid values for the Type property of a Profile.
These are the valid values for the Type property of a Profile.
Enumerated values of the Filter type.
These are the valid values for the Type property of a Profile.
UseRevalPendingParameterName is the name of a Parameter which tells whether or not Traffic Ops should use pending content invalidation jobs separately from traditionally "queued updates".
WarnLevel indicates dangerous but non-failing conditions.
X_MM_CLIENT_IP is an optional HTTP header that causes Traffic Router to use its value as the client IP address.

# Variables

EmailTemplate is an html/template.Template for formatting DeliveryServiceRequestRequests into text/html email bodies.
RequestStatuses -- user-visible string associated with each of the above.
StatusKey holds the text of the status key of a Request Context.
TrafficStatsDurationPattern reflects all the possible durations that can be requested via the /deliveryservice_stats endpoint.
ValidJobRegexPrefix matches the only valid prefixes for a relative-path Content Invalidation Job regular expression.

# Structs

AcmeAccount is the information needed to access an account with an ACME provider.
Alert represents an informational message, typically returned through the Traffic Ops API.
Alerts is merely a collection of arbitrary "Alert"s for ease of use in other structures, most notably those used in Traffic Ops API responses.
AllCacheGroupParametersResponse is a Cache Group Parameter response body.
AllDeliveryServiceFederationsMapping is a structure that contains identifying information for a Delivery Service as well as any and all Federation Resolver mapping assigned to it (or all those getting assigned to it).
AllFederationCDN is the structure of a response from Traffic Ops to a GET request made to its /federations/all endpoint.
APICapability represents an association between a Traffic Ops API route and a required capability.
APICapabilityResponse represents an HTTP response to an API Capability request.
ASN contains info relating to a single Autonomous System Number (see RFC 1930).
ASNNullable contains info related to a single Autonomous System Number (see RFC 1930).
ASNResponse is a single ASN response for Update and Create to depict what changed.
ASNResponseV50 is a single ASN response for Update and Create to depict what changed.
ASNsResponse is a list of ASNs (Autonomous System Numbers) as a response.
ASNsResponseV50 is a list of ASNs (Autonomous System Numbers) as a response.
ASNsV11 is used for the Traffic OPS API version 1.1, which lists ASNs (Autonomous System Numbers) under its own key in the response and does not validate structure.
ASNV50 is used for RFC3339 format timestamp.
AssignedDsResponse is the type of the `response` property of a response from Traffic Ops to a POST request made to its /servers/{{ID}}/deliveryservices API endpoint.
AssignFederationFederationResolversResponse represents an API response for assigning a Federation Resolver to a Federation.
AssignFederationResolversRequest represents an API request/response for assigning Federation Resolvers to a Federation.
AsyncStatus represents an async job status.
AsyncStatusResponse represents the response from the GET /async_status/{id} API.
CacheGroup contains information about a given cache group in Traffic Ops.
CacheGroupDetailResponse is the JSON object returned for a single Cache Group.
CacheGroupDetailResponseV50 is the JSON object returned for a single Cache Group.
CacheGroupNullable contains information about a given cache group in Traffic Ops.
CacheGroupNullableV50 contains information about a given cache group in Traffic Ops.
A CacheGroupParameter is an object that represents a Parameter, but also implies that it is associated with a Cache Group rather than (or in addition to) a Profile.
A CacheGroupParameterNullable is an object that represents a Parameter, but also implies that it is associated with a Cache Group rather than (or in addition to) a Profile.
CacheGroupParameterRequest is a Cache Group Parameter request body.
CacheGroupParametersList is the type of the `response` property of Traffic Ops's responses to its /cachegroupparameters API endpoint.
CacheGroupParametersNullable is the type of a response from Traffic Ops to a POST request made to its /cachegroupparameters API endpoint.
CacheGroupParametersPostResponse Response body when Posting to associate a Parameter with a Cache Group.
CacheGroupParametersResponse is a Cache Group Parameter response body.
CacheGroupParametersResponseNullable is the type of each entry in the `cachegroupParameters` property of the response from Traffic Ops to requests made to its /cachegroupparameters endpoint.
A CachegroupPostDSReq is a request to associate some Cache Group with a set of zero or more Delivery Services.
CacheGroupPostDSResp is the type of the `response` property of a response from Traffic Ops to a POST request made to its /cachegroups/{{ID}}/deliveryservices API endpoint.
CacheGroupPostDSRespResponse is the type of a response from Traffic Ops to a POST request made to its /cachegroups/{{ID}}/deliveryservices API endpoint.
CachegroupQueueUpdatesRequest holds info relating to the cachegroups/{{ID}}/queue_update TO route.
CachegroupQueueUpdatesRequestV50 holds info relating to the cachegroups/{{ID}}/queue_update TO route.
CacheGroupsNullableResponse is a response with a list of CacheGroupNullables.
CacheGroupsNullableResponseV50 is a response with a list of CacheGroupNullables.
CacheGroupsResponse is a list of CacheGroups as a response.
CacheGroupsResponseV50 is a list of CacheGroups as a response.
CachegroupTrimmedName is useful when the only info about a cache group you want to return is its name.
CachegroupTrimmedNameV50 is useful when the only info about a cache group you want to return is its name.
CacheGroupV50 contains information about a given cache group in Traffic Ops.
CapabilitiesResponse models the structure of a minimal response from the Capabilities API in Traffic Ops.
Capability reflects the ability of a user in ATC to perform some operation.
A CDN represents a set of configuration and hardware that can be used to serve content within a specific top-level domain.
CDNConfig includes the name and ID of a single CDN configuration.
A CDNDNSSECGenerateReq is the structure used to request generation of CDN DNSSEC Keys through the Traffic Ops API's /cdns/dnsseckeys/generate endpoint.
CDNDNSSECKeysResponse is the type of a response from Traffic Ops to GET requests made to its /cdns/name/{{name}}/dnsseckeys API endpoint.
CDNFederation represents a Federation.
CDNFederationDeliveryService holds information about an assigned Delivery Service within a CDNFederationV5 structure.
CDNFederationResponse represents a Traffic Ops API response to a request for one or more of a CDN's Federations.
CDNFederationsV5Response represents a Traffic Ops APIv5 response to a request for one or more of a CDN's Federations.
CDNFederationV5 represents a Federation of some CDN as it appears in version 5 of the Traffic Ops API.
CDNFederationV5Response represents a Traffic Ops APIv5 response to a request for a single CDN's Federations.
A CDNGenerateKSKReq is a request to generate Key-Signing Keys for CDNs for use in DNSSEC operations, and is the structure required for the bodies of POST requests made to the /cdns/{{Name}}/dnsseckeys/ksk/generate endpoint of the Traffic Ops API.
CDNLock is a struct to store the details of a lock that a user wishes to acquire on a CDN.
CDNLockCreateResponse is a struct to store the response of a CREATE operation on a lock.
CDNLocksGetResponse is a struct to store the response of a GET operation on locks.
CDNNotification is a notification created for a specific CDN.
CDNNotificationRequest encodes the request data for the POST cdn_notifications endpoint.
CDNNotificationsResponse is a list of CDN notifications as a response.
CDNNullable is identical to CDN except that its fields are reference values, which allows them to be nil.
CDNQueueUpdateResponse encodes the response data for the POST cdns/{{ID}}/queue_update endpoint.
CDNResponse is a single CDN response for Update and Create to depict what changed.
CDNsResponse is a list of CDNs as a response.
CDNSSLKey structures represent an SSL key/certificate pair used by a CDN.
A CDNSSLKeyCert represents an SSL key/certificate pair used by a CDN, without any other associated data.
CDNSSLKeys is an SSL key/certificate pair for a certain Delivery Service.
CDNSSLKeysCertificate is an SSL key/certificate pair.
CDNSSLKeysResponse is the structure of the Traffic Ops API's response to requests made to its /cdns/name/{{name}}/sslkeys endpoint.
CDNsV5Response is a list of CDNs as a response.
A CDNV5 represents a set of configuration and hardware that can be used to serve content within a specific top-level domain.
CommonAPIData contains generic data common to most Traffic Monitor API endpoints.
CommonCheckFields is a structure containing all of the fields common to both Serverchecks and GenericServerChecks.
CommonServerProperties is just the collection of properties which are shared by all servers across API versions.
Coordinate is a representation of a Coordinate as it relates to the Traffic Ops data model.
CoordinateNullable is identical to Coordinate except that its fields are reference values, which allows them to be nil.
CoordinateResponse is a single Coordinate response for Update and Create to depict what changed.
CoordinateResponseV5 is the type of a response from the /coordinates endpoint in the latest minor version of APIv5.
CoordinatesResponse is a list of Coordinates as a response.
CoordinatesResponseV5 is the type of a response from the /coordinates endpoint in the latest minor version of APIv5.
CoordinateV50 is the representation of a Coordinate used in API v5.0.
CoverageZoneFile is used for unmarshalling a Coverage Zone File.
No description provided by the author
CRConfig is JSON-serializable as the CRConfig used by Traffic Control.
CRConfigBackupLocations defines how a Traffic Router should handle traffic normally bound for a given CRConfigLatitudeLongitude in the event that said CRConfigLatitudeLongitude becomes unavailable, named with "CRConfig" for legacy reasons.
CRConfigBypassDestination is a network location to which excess traffic requesting a Delivery Service's content will be directed when the Service's ability to deliver content is deemed to be saturated, named with "CRConfig" for legacy reasons.
CRConfigConfig used to be the type of CRConfig's Config field, though CRConfigConfig is no longer used.
CRConfigDeliveryService represents a Delivery Service as they appear in CDN Snapshots, named with "CRConfig" for legacy reasons.
CRConfigDeliveryServiceProtocol is used in CDN Snapshots to define the protocols used to access Delivery Service content, named with "CRConfig" for legacy reasons.
CRConfigDispersion defines for a Delivery Service appearing in a CDN Snapshot the number of cache servers to which its content is initially distributed, named with "CRConfig" for legacy reasons.
CRConfigGeoEnabled is a structure that contains information describing a geographical location allowed to access a Delivery Service's content, named with "CRConfig" for legacy reasons.
CRConfigLatitudeLongitude structures are geographical locations for routing purpose that can contain either edge-tier cache servers or Traffic Routers (but not a mixture of both), named with "CRConfig" for legacy reasons.
CRConfigLatitudeLongitudeShort is a geographical location where clients will be assumed to be located if determining their location fails (a "Geo Miss"), named with "CRConfig" for legacy reasons.
CRConfigMonitor structures are used in CDN Snapshots to represent Traffic Monitors, named with "CRConfig" for legacy reasons.
CRConfigRouter represents a Traffic Router as defined within a CDN Snapshot, named with "CRConfig" for legacy reasons.
CRConfigStaticDNSEntry structures encode a Static DNS Entry for a Delivery Service in a CDN Snapshot, named with "CRConfig" for legacy reasons.
CRConfigStats is the type of the 'stats' property of a CDN Snapshot.
CRConfigTopology is the format in which Topologies are represented in a CDN Snapshot, named with "CRConfig" for legacy reasons.
CRConfigTrafficOpsServer represents a Traffic Ops instance as defined within a CDN Snapshot, named with "CRConfig" for legacy reasons.
CRConfigTTL defines the Time-To-Live (TTL) of various record types served by Traffic Router.
CreateCDNFederationResponse represents a Traffic Ops API response to a request to create a new Federation for a CDN.
CreateDeliveryServiceNullableResponse roughly models the structure of responses from Traffic Ops to POST requests made to its /deliveryservices API endpoint.
CreateUserResponse can hold a Traffic Ops API response to a POST request to create a user.
CreateUserResponseV4 can hold a Traffic Ops API response to a POST request to create a user in api v4.
CRSStats is the returned data from TRs stats endpoint.
CRSStatsApp represents metadata about a given TR.
CRSStatsStat represents an individual stat.
CRSStatsStats represents stats about a given TR.
CRStates includes availability data for caches and delivery services, as gathered and aggregated by this Traffic Monitor.
CRStatesDeliveryService contains data about the availability of a particular delivery service, and which caches in that delivery service have been marked as unavailable.
CurrentUserUpdateRequest differs from a regular User/UserCurrent in that many of its fields are *parsed* but not *unmarshaled*.
CurrentUserUpdateRequestUser holds all of the actual data in a request to update the current user.
DeleteCDNFederationResponse represents a Traffic Ops API response to a request to remove a Federation from a CDN.
DeleteDeliveryServiceResponse is the type of a response from Traffic Ops to DELETE requests made to its /deliveryservices/{{ID}} API endpoint.
DeleteTenantResponse is a legacy structure used to represent responses to DELETE requests made to Traffic Ops's /tenants API endpoint.
DeleteUserResponse can theoretically hold a Traffic Ops API response to a DELETE request to update a user.
DeliveryService structures represent a Delivery Service as it is exposed through the Traffic Ops API at version 1.4 - which no longer exists.
DeliveryServiceAcmeSSLKeysReq structures are requests to generate new key/certificate pairs for a Delivery Service using an ACME provider, and are the type of structures required for POST request bodies to the /deliveryservices/sslkeys/generate/letsencrypt endpoint of the Traffic Ops API.
DeliveryServiceAddSSLKeysReq structures are requests to import key/certificate pairs for a Delivery Service directly, and are the type of structures required for POST request bodies to the /deliveryservices/sslkeys/add endpoint of the Traffic Ops API.
DeliveryServiceCacheGroup breaks down the "health" of a Delivery Service by the number of cache servers responsible for serving its content within a specific Cache Group that are determined to be "online"/"healthy" and "offline"/"unhealthy".
DeliveryServiceCapacity represents the "capacity" of a Delivery Service as the portions of the pool of cache servers responsible for serving its content that are available for servicing client requests.
DeliveryServiceCapacityResponse is the type of a response from Traffic Ops to a request for a Delivery Service's "capacity".
DeliveryServiceFederationResolverMapping structures represent resolvers to which a Delivery Service maps "federated" CDN traffic.
DeliveryServiceFieldsV13 contains additions to Delivery Services introduced in Traffic Ops API v1.3.
DeliveryServiceFieldsV14 contains additions to Delivery Services introduced in Traffic Ops API v1.4.
DeliveryServiceFieldsV15 contains additions to Delivery Services introduced in Traffic Ops API v1.5.
DeliveryServiceFieldsV30 contains additions to Delivery Services introduced in API v3.0.
DeliveryServiceFieldsV31 contains additions to DeliverySservices introduced in API v3.1.
DeliveryServiceGenSSLKeysReq structures are requests to generate new key/certificate pairs for a Delivery Service, and are the type of structures required for POST request bodies to the /deliveryservices/sslkeys/generate endpoint of the Traffic Ops API.
DeliveryServiceHealth represents the "health" of a Delivery Service by the number of cache servers responsible for serving its content that are determined to be "online"/"healthy" and "offline"/"unhealthy".
DeliveryServiceHealthResponse is the type of a response from Traffic Ops to a request for a Delivery Service's "health".
DeliveryServiceIDRegex holds information relating to a single routing regular expression of a delivery service, e.g., one of those listed at the deliveryservices/{{ID}}/regexes TO API route.
DeliveryServiceIDRegexResponse is a list of DeliveryServiceIDRegexes.
DeliveryServiceIDs are pairs of identifiers for Delivery Services.
DeliveryServiceMatch structures are the type of each entry in a Delivery Service's Match List.
DeliveryServiceNullableFieldsV11 contains properties that Delivery Services as they appeared in Traffic Ops API v1.1 had, AND were not removed by ANY later API version.
DeliveryServiceNullableV11 represents a Delivery Service as they appeared in version 1.1 of the Traffic Ops API - which no longer exists.
DeliveryServiceNullableV12 represents a Delivery Service as they appeared in version 1.2 of the Traffic Ops API - which no longer exists.
DeliveryServiceNullableV13 represents a Delivery Service as they appeared in version 1.3 of the Traffic Ops API - which no longer exists.
DeliveryServiceNullableV14 represents a Delivery Service as they appeared in version 1.4 of the Traffic Ops API - which no longer exists.
DeliveryServiceNullableV15 represents a Delivery Service as they appeared in version 1.5 of the Traffic Ops API - which no longer exists.
DeliveryServiceRegex is a regular expression used for routing to a Delivery Service.
DeliveryServiceRegexes structures associate a set of Delivery Service Regular Expressions (Delivery Service "Regexes") with a particular Delivery Service.
DeliveryServiceRegexesTest is used to represent the entire deliveryservice_regex for testing.
DeliveryServiceRegexPost holds all of the information necessary to create a new routing regular expression for a delivery service.
DeliveryServiceRegexResponse is the type of a Traffic Ops API response to the /deliveryservices_regexes endpoint - in all API verions (at the time of this writing).
DeliveryServiceRemovedFieldsV11 contains properties of Delivery Services as they appeared in version 1.1 of the Traffic Ops API that were later removed in some other API version.
DeliveryServiceRequest is used as part of the workflow to create, modify, or delete a delivery service.
DeliveryServiceRequestComment is a struct containing the fields for a delivery service request comment.
DeliveryServiceRequestCommentNullable is a nullable struct containing the fields for a delivery service request comment.
DeliveryServiceRequestCommentsResponse is a list of DeliveryServiceRequestComments as a response.
DeliveryServiceRequestCommentsResponseV50 is a list of DeliveryServiceRequestCommentsV5 as a response, for API version 5.0.
DeliveryServiceRequestCommentV50 is a struct containing the fields for a delivery service request comment, for API version 5.0.
DeliveryServiceRequestDetails holds information about what a user is trying to change, with respect to a delivery service.
DeliveryServiceRequestNullable is used as part of the workflow to create, modify, or delete a delivery service.
DeliveryServiceRequestRequest is a literal request to make a Delivery Service.
DeliveryServiceRequestResponseV40 is the type of a response from Traffic Ops when creating, updating, or deleting a Delivery Service Request using API version 4.0.
DeliveryServiceRequestResponseV50 is the type of a response from Traffic Ops when creating, updating, or deleting a Delivery Service Request using the latest minor version of API version 5.
DeliveryServiceRequestsResponseV40 is the type of a response from Traffic Ops for Delivery Service Requests using API version 4.0.
DeliveryServiceRequestsResponseV5 is the type of a response from Traffic Ops for Delivery Service Requests using the latest minor version of API version 5.
DeliveryServiceRequestV40 is the type of a Delivery Service Request in Traffic Ops API version 4.0.
DeliveryServiceRequestV41 is the type of a Delivery Service Request in Traffic Ops API version 4.1.
DeliveryServiceRequestV50 is the type of a Delivery Service Request in Traffic Ops API version 5.0.
DeliveryServiceResponseV5 is the type of a response for API endponts returning a single Delivery Service in Traffic Ops API version 5.
DeliveryServiceSafeUpdateRequest represents a request to update the "safe" fields of a Delivery Service.
DeliveryServiceSafeUpdateResponse represents Traffic Ops's response to a PUT request to its /deliveryservices/{{ID}}/safe endpoint.
DeliveryServiceSafeUpdateResponseV30 represents Traffic Ops's response to a PUT request to its /api/3.0/deliveryservices/{{ID}}/safe endpoint.
DeliveryServiceSafeUpdateResponseV40 represents Traffic Ops's response to a PUT request to its /api/4.0/deliveryservices/{{ID}}/safe endpoint.
DeliveryServiceServer is the type of each entry in the `response` array property of responses from Traffic Ops to GET requests made to the /deliveryserviceservers endpoint of its API.
DeliveryserviceserverResponse - not to be confused with DSServerResponseV40 or DSServerResponse- is the type of a response from Traffic Ops to a request to the /deliveryserviceserver endpoint to associate servers with a Delivery Service.
DeliveryServiceServerResponse is the type of a response from Traffic Ops to a GET request to the /deliveryserviceserver endpoint.
DeliveryServiceServerResponseV50 is the type of a response from Traffic Ops to a GET request to the /deliveryserviceserver endpoint for API v5.0.
DeliveryServiceServers structures represent the servers assigned to a Delivery Service.
DeliveryServiceServerV50 is the type of each entry in the `response` array property of responses from Traffic Ops to GET requests made to the /deliveryserviceservers endpoint of its API, for api version 5.0.
DeliveryServicesNullableResponse roughly models the structure of responses from Traffic Ops to GET requests made to its /servers/{{ID}}/deliveryservices and /deliveryservices API endpoints.
DeliveryServicesRequiredCapabilitiesResponse is the type of a response from Traffic Ops to a request for relationships between Delivery Services and Capabilities which they require.
DeliveryServicesRequiredCapability represents an association between a required capability and a delivery service.
DeliveryServicesResponseV30 is the type of a response from the /api/3.0/deliveryservices Traffic Ops endpoint.
DeliveryServicesResponseV40 is the type of a response from the /api/4.0/deliveryservices Traffic Ops endpoint.
DeliveryServicesResponseV41 is the type of a response from the /api/4.1/deliveryservices Traffic Ops endpoint.
DeliveryServicesResponseV5 is the type of a response from the /deliveryservices Traffic Ops endpoint in version 5 of its API.
DeliveryServiceSSLKeys contains information about an SSL key and certificate used by a Delivery Service to secure its HTTP-delivered content.
DeliveryServiceSSLKeysCertificate contains an SSL key/certificate pair for a Delivery Service, as well as the Certificate Signing Request associated with them.
DeliveryServiceSSLKeysGenerationResponse is the type of a response from Traffic Ops to a request for generation of SSL Keys for a Delivery Service.
DeliveryServiceSSLKeysReq structures are requests for the generation of SSL key certificate pairs for a Delivery Service, and this is, in fact, the structure required for POST request bodies to the /deliveryservices/sslkeys/generate Traffic Ops API endpoint.
DeliveryServiceSSLKeysResponse is the type of a response from Traffic Ops to GET requests made to its /deliveryservices/xmlId/{{XML ID}}/sslkeys API endpoint.
DeliveryServiceSSLKeysV15 structures contain information about an SSL key certificate pair used by a Delivery Service.
DeliveryServiceSSLKeysV41 structures contain information about an SSL key certificate pair used by a Delivery Service.
DeliveryServiceUserPost represents a legacy concept that no longer exists in Apache Traffic Control.
DeliveryServiceV11 contains the information relating to a Delivery Service that was around in version 1.1 of the Traffic Ops API.
DeliveryServiceV13 structures represent a Delivery Service as it is exposed through the Traffic Ops API at version 1.3 - which no longer exists.
DeliveryServiceV30 represents a Delivery Service as they appear in version 3.0 of the Traffic Ops API.
DeliveryServiceV31 represents a Delivery Service as they appear in version 3.1 of the Traffic Ops API.
DeliveryServiceV40 is a Delivery Service as it appears in version 4.0 of the Traffic Ops API.
DeliveryServiceV41 is a Delivery Service as it appears in version 4.1 of the Traffic Ops API.
DeliveryServiceV50 is a Delivery Service as it appears in version 5.0 of the Traffic Ops API.
A Division is a named collection of Regions.
DivisionNullable is a nullable struct that holds info about a division, which is a group of regions.
DivisionResponse is a single Division response for Update and Create to depict what changed.
DivisionResponseV50 is a single Division response for Update and Create to depict what changed.
DivisionsResponse is a list of Divisions as a response.
DivisionsResponseV50 is a list of Divisions as a response.
A DivisionV50 is a named collection of Regions.
A DNSSECKey is a DNSSEC Key (Key-Signing or Zone-Signing) and all associated data - computed data as well as data that is actually stored by Traffic Vault.
DNSSECKeyDSRecord structures are used by the Traffic Ops API after version 1.1, and they contain all the same information as well as an additional "Text" property of unknown purpose.
DNSSECKeyDSRecordV11 structures contain meta information for Key-Signing DNSSEC Keys (KSKs) used by Delivery Services.
A DNSSECKeySet is a set of keys used for DNSSEC zone and key signing.
DNSSECKeySetV11 is a DNSSEC key set (ZSK and KSK), as stored in Traffic Vault.
A DNSSECKeyV11 represents a DNSSEC Key (Key-Signing or Zone-Signing) as it appeared in Traffic Ops API version 1.1.
Domain contains information about a single Profile within a Domain.
DomainNullable is identical to a Domain but with reference properties that can have nil values, mostly used by the Traffic Ops API.
DomainsResponse is a list of Domains as a response.
DSServer contains information for a Delivery Service Server.
DSServerBase contains the base information for a Delivery Service Server.
DSServerBaseV4 contains the base information for a Delivery Service Server.
A DSServerIDs is a description of relationships between a Delivery Service and zero or more servers, as well as how that relationship may have been recently modified.
DSServerResponseV30 is the type of a response from Traffic Ops to a request for servers assigned to a Delivery Service - in API version 3.0.
DSServerResponseV40 is the type of a response from Traffic Ops to a request for servers assigned to a Delivery Service - in API version 4.0.
DSServerResponseV50 is response from Traffic Ops to a request for servers assigned to a Delivery Service - in the latest minor version APIv50.
DSServersResponse is the type of a response from Traffic Ops to a POST request made to the /deliveryservices/{{XML ID}}/servers endpoint of its API.
DSServerV11 contains the legacy format for a Delivery Service Server.
DSServerV4 contains information for a V4.x Delivery Service Server.
DSServerV50 contains information about a server associated with some Delivery Service Server.
DSSMapResponse is the type of the `response` property of a response from Traffic Ops to a PUT request made to the /deliveryserviceserver endpoint of its API.
DSSReplaceResponse is the type of a response from Traffic Ops to a PUT request made to the /deliveryserviceserver endpoint of its API.
A FederationDeliveryServiceNullable is an association between a Federation and a Delivery Service.
FederationDeliveryServicesResponse is the type of a response from Traffic Ops to a request made to its /federations/{{ID}}/deliveryservices endpoint.
FederationDSPost is the format of a request to associate a Federation with any number of Delivery Services.
FederationFederationResolversResponse represents an API response containing Federation Resolvers for a given Federation.
A FederationMapping is a Federation, without any information about its resolver mappings or any relation to Delivery Services.
FederationNullable represents a relationship between some Federation Mappings and a Delivery Service.
FederationResolver represents a resolver record for a CDN Federation.
FederationResolverMapping is the set of all resolvers - both IPv4 and IPv6 - for a specific Federation.
FederationResolverResponse represents a Traffic Ops API response to a POST or DELETE request to its /federation_resolvers endpoint.
FederationResolverResponseV50 - POST request to its /federation_resolvers endpoint APIv50.
FederationResolversResponse represents a Traffic Ops API response to a GET request to its /federation_resolvers endpoint.
FederationResolversResponseV50 - GET request to its /federation_resolvers endpoint for APIv50.
FederationResolverV50 - is used for RFC3339 format timestamp in FederationResolver which represents a resolver record for a CDN Federation for APIv50.
FederationsResponse is the type of a response from Traffic Ops to requests to its /federations/all and /federations endpoints.
FederationUser represents Federation Users.
FederationUserPost represents POST body for assigning Users to Federations.
FederationUsersResponse is the type of a response from Traffic Ops to a request made to its /federations/{{ID}}/users endpoint.
GenerateCDNDNSSECKeysResponse is the type of a response from Traffic Ops to requests made to its /cdns/dnsseckeys/generate and /cdns/dnsseckeys/ksk/generate API endpoints.
GenericServerCheck represents a server with some associated meta data presented along with its arbitrary "checks".
GetTenantsResponse is the response for a request for a group of tenants.
GetTenantsResponseV50 is the response for a request for a group of tenants.
HealthData is a representation of all of the health information for a CDN or Delivery Service.
HealthDataCacheGroup holds health information specific to a particular Cache Group.
HealthThreshold describes some value against which to compare health measurements to determine if a cache server is healthy.
HealthThresholdJSONParameters contains Parameters whose Thresholds must be met in order for Caches using the Profile containing these Parameters to be marked as Healthy.
HWInfo can be used to return information about a server's hardware, but the corresponding Traffic Ops API route is deprecated and unusable without alteration.
HWInfoResponse is a list of HWInfos as a response.
InvalidationJob represents a content invalidation job as returned by the API.
InvalidationJobCreateV40 represents user input intending to create a content invalidation job.
InvalidationJobInput represents user input intending to create or modify a content invalidation job.
InvalidationJobsResponse is the type of a response from Traffic Ops to a request made to its /jobs API endpoint.
InvalidationJobsResponse is the type of a response from Traffic Ops to a request made to its /jobs API endpoint for v 4.0+.
InvalidationJobV40 represents a content invalidation job as returned by the API.
IsAvailable contains whether the given cache or delivery service is available.
Job represents a content invalidation job as stored in the database.
JobRequest contains the data to create a job.
JobRequestAPI represents the JSON input accepted by the API for creating new content invalidation jobs.
LegacyDeliveryServiceFederationResolverMappingRequest is the legacy format for a request to create (or modify) the Federation Resolver mappings of one or more Delivery Services.
LegacyInterfaceDetails is the details for interfaces on servers for API v2.
LegacyStats is designed for returning via the API.
LegacyTMConfigResponse was the response to requests made to the cdns/{{Name}}/configs/monitoring endpoint of the Traffic Ops API in older API versions.
LegacyTrafficDSStatsSummary contains summary statistics for a data series for Delivery Service stats.
LegacyTrafficMonitorConfig represents TrafficMonitorConfig for ATC versions before 5.0.
LegacyTrafficMonitorConfigMap is a representation of a LegacyTrafficMonitorConfig using unique values as map keys.
A LegacyTrafficServer is a representation of a cache server containing a subset of the information available in a server structure that conveys all the information important for Traffic Router and Traffic Monitor to handle it.
Log contains a change that has been made to the Traffic Control system.
LogsResponse is a list of Logs as a response.
LogsResponseV50 is a list of Logs as a response, for api version 5.0.
LogV50 contains a change that has been made to the Traffic Control system, for api version 5.0.
A MatchList is actually just a single match item in a match list.
MatchSet structures are a list of MatchList structures with an associated Protocol.
MonitoringCoordinates holds a coordinate pair for inclusion as a field in TMCacheGroup.
MultipleServersCapabilities represents an association between a server capability and list of servers and an association between a server and list of server capabilities.
NewLogCountResp is the response returned when the total number of new changes made to the Traffic Control system is requested.
Origin contains information relating to an Origin, which is NOT, in general, the same as an origin *server*.
OriginDetailResponse is the JSON object returned for a single origin.
OriginDetailResponseV50 is the JSON object returned for a single origin in APIv5.
OriginsResponse is a list of Origins as a response.
OriginsResponseV50 is a list of Origins as a response for APIv5.
OriginV50 contains information relating to an Origin, in the latest minor version APIv50.
OSVersionsAPIResponse is the type of a response from Traffic Ops to a request to its /osversions endpoint.
A Parameter defines some configuration setting (which is usually but definitely not always a line in a configuration file) used by some Profile or Cache Group.
ParameterNullable is exactly like Parameter except that its properties are reference values, so they can be nil.
ParameterNullableV50 is exactly like Parameter except that its properties are reference values, so they can be nil.
ParametersResponse is the type of the response from Traffic Ops to GET requests made to the /parameters and /profiles/name/{{Name}}/parameters endpoints of its API.
ParametersResponseV50 is the type of the response from Traffic Ops to GET requests made to the /parameters and /profiles/name/{{Name}}/parameters endpoints of its API.
A ParameterV50 defines some configuration setting (which is usually but definitely not always a line in a configuration file) used by some Profile or Cache Group.
PhysLocation contains the physical location of a cache group.
PhysLocationNullable contains the physical location of a cache group.
PhysLocationNullableV50 contains the physical location of a cache group.
PhysLocationResponse is a single PhysLocationNullable as a response.
PhysLocationResponseV50 is a single PhysLocationNullable as a response.
PhysLocationsResponse is a list of PhysLocations as a response.
PhysLocationsResponseV50 is a list of PhysLocations as a response.
PhysLocationTrimmed contains only the name of a physical location.
PhysLocationV50 contains the physical location of a cache group.
Plugin represents a TO enabled plugin used by Traffic Ops.
PluginsResponse represents the response from Traffic Ops when getting enabled plugins.
A PostParamProfile is a request to associate a particular Parameter with zero or more Profiles.
A PostProfileParam is a request to associate zero or more Parameters with a particular Profile.
A Profile represents a set of configuration for a server or Delivery Service which may be reused to allow sharing configuration across the objects to which it is assigned.
ProfileCopy contains details about the profile created from an existing profile.
ProfileCopyResponse represents the Traffic Ops API's response when a Profile is copied.
ProfileExportImportNullable is an object of the form used by Traffic Ops to represent exported and imported profiles.
ProfileExportImportParameterNullable is an object of the form used by Traffic Ops to represent parameters for exported and imported profiles.
ProfileExportResponse is an object of the form used by Traffic Ops to represent exported profile response.
ProfileImportRequest is an object of the form used by Traffic Ops to represent a request to import a profile.
ProfileImportResponse is an object of the form used by Traffic Ops to represent a response from importing a profile.
ProfileImportResponseObj contains data about the profile being imported.
ProfileNullable is exactly the same as Profile except that its fields are reference values, so they may be nil.
ProfileParam is a relationship between a Profile and some Parameter assigned to it as it appears in the Traffic Ops API's responses to the /profileparameters endpoint.
ProfileParameter is a representation of a relationship between a Parameter and a Profile to which it is assigned.
ProfileParameterByName is a structure that's used to represent a Parameter in a context where they are associated with some Profile specified by a client of the Traffic Ops API by its Name.
ProfileParameterByNamePost is a structure that's only used internally to represent a Parameter that has been requested by a client of the Traffic Ops API to be associated with some Profile which was specified by Name.
ProfileParameterByNameV50 is a structure that's used to represent a Parameter in a context where they are associated with some Profile specified by a client of the Traffic Ops API by its Name.
ProfileParameterCreationRequest is the type of data accepted by Traffic Ops as payloads in POST requests to its /profileparameters endpoint.
ProfileParameterNullable is identical to ProfileParameter, except that its fields are reference values, which allows them to be nil.
ProfileParameterPostResp is the type of the `response` property of responses from Traffic Ops to POST requests made to its /profiles/name/{{Name}}/parameters API endpoint.
ProfileParameterPostRespObj is a single Parameter in the Parameters slice of a ProfileParameterPostResp.
ProfileParameterResponse is a single ProfileParameter response for Create to depict what changed.
ProfileParameterResponseV5 is a single ProfileParameter response for Create to depict what changed.
ProfileParametersAPIResponse is the type of a response from Traffic Ops to requests made to its /profileparameters endpoint.
ProfileParametersAPIResponseV50 is the type of a response from Traffic Ops to requests made to its /profileparameters endpoint.
ProfileParametersNullable is an object of the form returned by the Traffic Ops /profileparameters endpoint.
ProfileParametersNullableResponse is the structure of a response from Traffic Ops to GET requests made to its /profileparameters API endpoint.
ProfileParametersNullableV50 is an object of the form returned by the Traffic Ops /profileparameters endpoint.
ProfileParametersResponse is the type of the response from Traffic Ops to GET requests made to its /profileparameters API endpoint.
ProfileParametersResponseV5 is the type of the response from Traffic Ops to GET requests made to its /profileparameters API endpoint.
ProfileParameterV50 is a representation of a relationship between a Parameter and a Profile to which it is assigned.
ProfileParamV50 is a relationship between a Profile and some Parameter assigned to it as it appears in the Traffic Ops API's responses to the /profileparameters endpoint.
ProfileResponse is a single Profile Response for Update and Create to depict what changed swagger:response ProfileResponse in: body.
ProfilesResponse is a list of profiles returned by GET requests.
ProfilesResponseV5 is a list of profiles returned by GET requests.
A ProfileV5 represents a set of configuration for a server or Delivery Service which may be reused to allow sharing configuration across the objects to which it is assigned.
PutSnapshotResponse is the type of the response of Traffic Ops to requests for *making* CDN Snapshots.
A Region is a named collection of Physical Locations within a Division.
RegionName is a response to a request to get a region by its name.
RegionNameDivision is the division that contains the region that a request is trying to query by name.
RegionNameResponse models the structure of a response to a request to get a region by its name.
No description provided by the author
RegionsResponseV50 is response made from /regions API endpoint - in the latest minor version APIv50.
RegionV50 is a named collection of Physical Locations within a Division in the latest minor version APIv50.
A ResolverMapping is a set of Resolvers, ostensibly for a Federation.
ResultStatVal is the value of an individual stat returned from a poll.
A Role is a definition of the permissions afforded to a user with that Role.
RoleResponse is a single Role response for Update and Create to depict what changed.
RoleResponseV4 is a RoleV4 as a response.
RolesResponse is a list of Roles as a response.
RolesResponseV4 is a list of RoleV4 as a response.
RoleV11 is a representation of a Role as it appeared in version 1.1 of the Traffic Ops API.
RoleV40 is the structure used to depict roles in API v4.0.
Routing represents the aggregated routing percentages across CDNs or for a DS.
Server is a non-"nullable" representation of a Server as it appeared in API version 2.0 Deprecated: Please use versioned and nullable structures from now on.
ServerCapabilitiesResponse contains the result data from a GET /server_capabilities request.
ServerCapabilitiesResponseV41 contains the result data from a GET(v4.1 and above) /server_capabilities request.
ServerCapabilitiesResponseV50 contains the result data from a GET(v5.1 and above) /server_capabilities request.
ServerCapability contains information about a given ServerCapability in Traffic Ops.
ServerCapabilityDetailResponse contains the result data from a POST /server_capabilities request.
ServerCapabilityDetailResponseV41 contains the result data from a POST(v4.1 and above) /server_capabilities request.
ServerCapabilityDetailResponseV50 contains the result data from a POST(v5.1 and above) /server_capabilities request.
ServerCapabilityV41 contains information (in-addition to description) about a given ServerCapability in Traffic Ops.
ServerCapabilityV50 contains information about a given serverCapability in Traffic Ops V5.
Servercheck is a single Servercheck struct for GET response.
ServercheckAPIResponse (not to be confused with ServerchecksResponse) is the type of a response from Traffic Ops to a request to its /servercheck endpoint (not to be confused with its /servers/checks endpoint).
ServerCheckColumns is a collection of columns associated with a particular server's "checks".
A ServerCheckExtensionID contains an identified for a Servercheck Extension.
ServerCheckExtensionNullable represents a server check extension used by Traffic Ops.
ServerCheckExtensionPostResponse represents the response from Traffic Ops when creating ServerCheckExtension.
ServerCheckExtensionResponse represents the response from Traffic Ops when getting ServerCheckExtension.
ServercheckPost is a single Servercheck struct for Update and Create to depict what changed.
ServercheckPostResponse is the response to a Servercheck POST request.
ServercheckRequestNullable is a single nullable Servercheck struct for Update and Create to depict what changed.
ServerchecksResponse is a list of Serverchecks as a response.
ServerDetail is a type that contains a superset of the information available in a ServerNullable.
ServerDetailV11 is the type of each entry in the `response` array property of responses from Traffic Ops to GET requests made to its /servers/details API endpoint in API version 2.0.
ServerDetailV30 is the details for a server for API v3.
ServerDetailV40 is the details for a server for API v4.
ServerInfo is a stripped-down type containing a subset of information for a server.
ServerInterfaceInfo is the data associated with a server's interface.
ServerInterfaceInfoV40 is the data associated with a V40 server's interface.
ServerIPAddress is the data associated with a server's interface's IP address.
ServerNullableV11 is a server as it appeared in API version 1.1.
ServerNullableV2 is a server as it appeared in API v2.
ServerPutStatus is a request to change the Status of a server, optionally with an explanation.
ServerQueueUpdate decodes the update data from the POST servers/{{ID}}/queue_update endpoint.
ServerQueueUpdateRequest encodes the request data for the POST servers/{{ID}}/queue_update endpoint.
ServerQueueUpdateResponse decodes the full response with alerts from the POST servers/{{ID}}/queue_update endpoint.
ServersDetailResponse is the JSON object returned for a single server.
ServerServerCapabilitiesResponse is the type of a response from Traffic Ops to a request made to its /server_server_capabilities.
ServerServerCapabilitiesResponseV50 is the type of a response from Traffic Ops to a request made to its /api/5.0/server_server_capabilities.
ServerServerCapability represents an association between a server capability and a server.
ServerServerCapabilityV50 represents an association between a server capability and a server.
ServersResponse is a list of Servers as a response to an API v2 request.
ServerStats is a representation of cache server statistics as present in the TM API.
ServersV1DetailResponse is the JSON object returned for a single server for v1.
ServersV3DetailResponse is the JSON object returned for a single server for v3.
ServersV3Response is the format of a response to a GET request for /servers.
ServersV4DetailResponse is the JSON object returned for a single server for v4.
ServersV4Response is the format of a response to a GET request for API v4.x /servers.
ServersV5Response is the format of a response to a GET request to /servers in APIv5.
ServerUpdateStatus is the type of each entry in the `response` property of the response from Traffic Ops to GET requests made to its /servers/{{host name}}/update_status API endpoint.
ServerUpdateStatusResponseV40 is the type of a response from the Traffic Ops API to a request to its /servers/{{host name}}/update_status endpoint in API version 4.0.
ServerUpdateStatusResponseV50 is the type of a response from the Traffic Ops API to a request to its /servers/{{host name}}/update_status endpoint in API version 5.0.
ServerUpdateStatusV40 is the type of each entry in the `response` property of the response from Traffic Ops to GET requests made to its /servers/{{host name}}/update_status in API v4.0 endpoint.
ServerUpdateStatusV50 is the type of each entry in the `response` property of the response from Traffic Ops to GET requests made to its /servers/{{host name}}/update_status in API v5.0 endpoint.
ServerV30 is the representation of a Server in version 3 of the Traffic Ops API.
ServerV40 is the representation of a Server in version 4.0 of the Traffic Ops API.
ServerV50 is the representation of a Server in version 5.0 of the Traffic Ops API.
ServerV5Response is the format of a response to single-server operations using /servers in APIv5.
ServiceCategoriesResponse is a list of Service Categories as a response.
ServiceCategoriesResponseV50 is a list of Service Categories as a response.
ServiceCategory holds the name, id and associated tenant that comprise a service category.
ServiceCategoryResponse is a single Service Category response for Update and Create to depict what changed.
ServiceCategoryResponseV50 is a single Service Category response for Update and Create to depict what changed.
ServiceCategoryV50 holds the name and last updated time stamp.
SnapshotResponse is the type of the response of Traffic Ops to requests for CDN Snapshots.
SOA (Start of Authority record) defines the SOA record for the CDN's top-level domain.
SSLKeyExpirationGetResponse is the format of a response to a GET request for API /sslkey_expirations endpoint.
SSLKeyExpirationInformation contains information about an SSL key's expiration.
SSLKeyRequestFields contain metadata information for generating SSL keys for Delivery Services through the Traffic Ops API.
SSLKeysAddResponse is a struct to store the response of addition of ssl keys for a DS, along with any alert messages.
StaticDNSEntriesResponse is a list of StaticDNSEntry as a response.
StaticDNSEntriesResponseV50 is a list of StaticDNSEntry as a response, for api version 5.0.
StaticDNSEntry holds information about a static DNS entry.
StaticDNSEntryNullable holds information about a static DNS entry.
StaticDNSEntryV50 holds information about a static DNS entry, for api version 5.0.
Stats is designed for returning via the API.
StatsSummary is a summary of some kind of statistic for a CDN and/or Delivery Service.
StatsSummaryLastUpdated is the type of the `response` property of a response from Traffic Ops to a GET request made to its /stats_summary endpoint when the 'lastSummaryDate' query string parameter is passed as 'true'.
StatsSummaryLastUpdatedAPIResponse is the type of a response from Traffic Ops to a request to its /stats_summary endpoint with the 'lastSummaryDate' query string parameter set to 'true'.
StatsSummaryLastUpdatedAPIResponseV50 is the type of a response from Traffic Ops to a request to its /stats_summary endpoint with the 'lastSummaryDate' query string parameter set to 'true'.
StatsSummaryLastUpdatedResponse is the type of a response from Traffic Ops to a GET request made to its /stats_summary endpoint when the 'lastSummaryDate' query string parameter is passed as 'true'.
StatsSummaryLastUpdatedV50 is the type of the `response` property of a response from Traffic Ops to a GET request made to its /stats_summary endpoint when the 'lastSummaryDate' query string parameter is passed as 'true'.
StatsSummaryResponse is the structure of a response from Traffic Ops to GET requests made to its /stats_summary API endpoint.
StatsSummaryResponseV50 is the structure of a response from Traffic Ops to GET requests made to its /stats_summary V5 API endpoint.
StatsSummaryV50 is a summary of some kind of statistic for a CDN and/or Delivery Service.
Status is a single Status response for Update and Create to depict what changed.
StatusChangeRequest is the form of a PUT request body to /deliveryservice_requests/{{ID}}/status.
StatusesResponse is a list of Statuses as a response that depicts the state of a server.
StatusesResponseV50 is a list of Statuses as a response that depicts the state of a server.
StatusNullable is a nullable single Status response for Update and Create to depict what changed.
StatusResponse is a single Status response for Update and Create to depict what changed.
StatusResponseV5 is the type of a response for API endponts returning a single Status in Traffic Ops API version 5.
StatusNullableV5 is a nullable single Status response for Update and Create to depict what changed.
Steering holds information about a steering delivery service.
SteeringFilter is a filter for a target delivery service.
SteeringResponse is the type of a response from Traffic Ops to a request to its /steering endpoint.
SteeringSteeringTarget is a target delivery service of a steering delivery service.
A SteeringTarget is a relationship between a Steering Delivery Service and another Delivery Service which is one of its Targets.
A SteeringTargetNullable is a relationship between a Steering Delivery Service and another Delivery Service which is one of its Targets.
SteeringTargetsResponse is the type of a response from Traffic Ops to its /steering/{{ID}}/targets endpoint.
SystemInfo can hold arbitrary system information (e.g., as a Traffic Ops API response).
A Tenant is a scope that can be applied to groups of users to limit their Delivery Service-related actions to specific sets of similarly "Tenanted" Delivery Services.
TenantAlert is an unnecessary and less type-safe duplicate of Alert.
TenantNullable is identical to Tenant, but its fields are reference values, which allows them to be nil.
TenantResponse is the type of a response from Traffic Ops to a PUT, POST, or DELETE request made to its /tenants.
TenantResponseV50 is the type of response from Traffic Ops to a PUT, POST, or DELETE request made to its /tenants.
A TenantV50 is a scope that can be applied to groups of users to limit their Delivery Service-related actions to specific sets of similarly "Tenanted" Delivery Services.
Time wraps standard time.Time to allow indication of invalid times.
TMCacheGroup contains all of the information about a Cache Group necessary for Traffic Monitor to do its job of monitoring health and statistics.
TMConfigResponse is the response to requests made to the cdns/{{Name}}/configs/monitoring endpoint of the Traffic Ops API.
TMDeliveryService is all of the information about a Delivery Service necessary for Traffic Monitor to do its job of monitoring health and statistics.
TMParameters is a structure containing all of the Parameters with special meaning to Traffic Monitor.
TMProfile is primarily a collection of the Parameters with special meaning to Traffic Monitor for a Profile of one of the monitored cache servers and/or other Traffic Monitors, along with some identifying information for the Profile.
A TOExtensionID contains an identifier for a particular Traffic Ops extension.
TOExtensionNullable represents a TO extension used by Traffic Ops.
TOExtensionPostResponse represents the response from Traffic Ops when creating TOExtension.
TOExtensionResponse represents the response from Traffic Ops when getting TOExtension.
TopologiesQueueUpdate decodes the update data from the POST topologies/{{name}}/queue_update endpoint.
TopologiesQueueUpdateRequest encodes the request data for the POST topologies/{{name}}/queue_update endpoint.
TopologiesQueueUpdateResponse encodes the response data for the POST topologies/{{name}}/queue_update endpoint.
TopologiesResponse models the JSON object returned for a list of topologies in a response.
TopologiesResponseV50 models the JSON object returned for a list of topologies in a response, as represented in api version 5.0.
Topology holds the name and set of TopologyNodes that comprise a flexible topology.
TopologyNode holds a reference to a cachegroup and the indices of up to 2 parent nodes in the same topology's array of nodes.
TopologyNodeV50 holds a reference to a cachegroup and the indices of up to 2 parent nodes in the same topology's array of nodes, as represented in api version 5.0.
TopologyResponse models the JSON object returned for a single Topology in a response from the Traffic Ops API.
TopologyResponseV50 models the JSON object returned for a single Topology in a response from the Traffic Ops API, as represented in api version 5.0.
TopologyV50 holds the name and set of TopologyNodes that comprise a flexible topology, as represented in api version 5.0.
TrafficCacheStatsConfig represents the configuration of a request made to Traffic Stats for cache server stats.
TrafficDSStatsConfig represents the configuration of a request made to Traffic Stats for Delivery Service stats.
TrafficDSStatsResponse represents a response from the /deliveryservice_stats "Traffic Stats" endpoints.
TrafficDSStatsSummary contains summary statistics for a data series for deliveryservice stats.
TrafficMonitor is a structure containing enough information about a Traffic Monitor instance for another Traffic Monitor to use it for quorums and peer polling.
TrafficMonitorConfig is the full set of information needed by Traffic Monitor to do its job of monitoring health and statistics of cache servers.
TrafficMonitorConfigMap is a representation of a TrafficMonitorConfig using unique values as map keys.
TrafficServer represents a cache server for use by Traffic Monitor and Traffic Router instances.
TrafficStatsCDNsStats contains a list of CDN summary statistics.
TrafficStatsCDNStats contains summary statistics for a given CDN.
TrafficStatsCDNStatsResponse contains response for getting current stats.
TrafficStatsConfig represents the configuration of a request made to Traffic Stats.
TrafficStatsResponse represents the generic response from one of the "Traffic Stats endpoints" of the Traffic Ops API, e.g.
TrafficStatsSeries is the actual data returned by a request to a "Traffic Stats endpoint".
TrafficStatsSummary contains summary statistics for a data series.
TrafficStatsTotalStats contains summary statistics across CDNs.
TrafficVaultPing represents the status of a given Traffic Vault server.
TrafficVaultPingResponse represents the JSON HTTP response returned by the /vault/ping route.
TSDeliveryService represents a delivery service as assigned to a TrafficServer in the TMConfig.
Type contains information about a given Type in Traffic Ops.
TypeNullable contains information about a given Type in Traffic Ops.
TypesResponse is the type of a response from Traffic Ops to a GET request made to its /types API endpoint.
TypesResponseV50 is the type of response (for RFC3339) from Traffic Ops to a GET Request made to its /types API endpoint.
TypeV50 contains information about a given Type in Traffic Ops.
UpdateCDNFederationResponse represents a Traffic Ops API response to a request to replace a Federation of a CDN with the one provided in the request body.
UpdateDeliveryServiceNullableResponse roughly models the structure of responses from Traffic Ops to PUT requests made to its /deliveryservices/{{ID}} API endpoint.
UpdateUserResponse can hold a Traffic Ops API response to a PUT request to update a user.
UpdateUserResponseV4 can hold a Traffic Ops API response to a PUT request to update a user for the latest 4.x api version variant.
URLSignatureKeysResponse is the type of a response from Traffic Ops to a request for the URL Signing keys of a Delivery Service - in API version 4.0.
User represents a user of Traffic Ops.
UserCredentials contains Traffic Ops login credentials.
UserCurrent represents the profile for the authenticated user.
UserCurrentResponse can hold a Traffic Ops API response to a request to get or update the current user.
UserCurrentResponseV4 is the latest 4.x Traffic Ops API version variant of UserResponse.
UserDeliveryServiceDeleteResponse can hold a Traffic Ops API response to a request to remove a delivery service from a user.
UserDeliveryServicePostResponse represents a legacy concept that no longer exists in Apache Traffic Control.
UserInvalidationJob is a full representation of content invalidation jobs as stored in the database, including several unused fields.
UserInvalidationJobInput Represents legacy-style user input to the /user/current/jobs API endpoint.
UserPasswordResetRequest can hold Traffic Ops API request to reset a user's password.
UserRegistrationRequest is the request submitted by operators when they want to register a new user.
UserRegistrationRequestV40 is the request submitted by operators when they want to register a new user in api V4.
UserResponse can hold a Traffic Ops API response to a request to get a user.
UserResponseV4 is the type of a response from Traffic Ops to requests made to /users which return one user for the latest 4.x api version variant.
UsersResponse can hold a Traffic Ops API response to a request to get a list of users.
UsersResponseV4 is the type of a response from Traffic Ops to requests made to /users which return more than one user for the latest 4.x api version variant.
UserToken represents a request payload containing a UUID token for authentication.
A UserV40 is a representation of a Traffic Ops user as it appears in version 4.0 of Traffic Ops's API.

# Interfaces

IAllFederation is an interface for the disparate objects returned by Federations-related Traffic Ops API endpoints.

# Type aliases

AlertLevel is used for specifying or comparing different levels of alerts.
ASNResponseV5 is an alias for the ASN struct response used for the latest minor version associated with api major version 5.
ASNsResponseV5 is an alias for the list of ASN struct response used for the latest minor version associated with api major version 5.
ASNV5 is an alias for the ASN struct response used for the latest minor version associated with api major version 5.
CacheGroupDetailResponseV5 is the type of response from the cachegroups Traffic Ops endpoint.
CacheGroupName is the name of a Cache Group.
CacheGroupNullableV5 always points to the type for the latest minor version of CacheGroupNullableV5x APIv5.
CachegroupQueueUpdatesRequestV5 is the type of request to the cachegroups Traffic Ops endpoint.
CacheGroupsNullableResponseV5 is the type of response from the cachegroups Traffic Ops endpoint.
CacheGroupsResponseV5 is the type of response from the cachegroups Traffic Ops endpoint.
CachegroupTrimmedNameV5 always points to the type for the latest minor version of CachegroupTrimmedNameV5x APIv5.
CacheGroupV5 always points to the type for the latest minor version of CacheGroupV5x APIv5.
CacheName is the (short) hostname of a cache server.
CacheStatus is a Name of some Status.
CacheType is the type (or tier) of a cache server.
CDNDNSSECGenerateReqDate is the date accepted by CDNDNSSECGenerateReq.
CDNLockDeleteResponse is a struct to store the response of a DELETE operation on a lock.
CDNName is the name of a CDN in Traffic Control.
CDNQueueUpdateRequest encodes the request data for the POST cdns/{{ID}}/queue_update endpoint.
CDNSSLKeysResp is a slice of CDNSSLKeys.
ConfigFileName is a Parameter ConfigFile value.
CoordinateV5 is the representation of a Coordinate used in the latest minor version of APIv5.
CRConfigRouterStatus is the name of the Status of a Traffic Router server object.
CRConfigServerStatus is the name of the Status of a server object.
CurrentStatsResponse is the type of a response from Traffic Ops to a request to its /current_stats endpoint.
DeepCachingType represents a Delivery Service's Deep Caching Type.
DeleteCDNDNSSECKeysResponse is the type of a response from Traffic Ops to DELETE requests made to its /cdns/name/{{name}}/dnsseckeys API endpoint.
DeliveryServiceActiveState is an "enumerated" type which encodes the valid values of a Delivery Service's 'Active' property (v3.0+).
DeliveryServiceFederationResolverMappingRequest is the format of a request to create (or modify) the Federation Resolver mappings of one or more Delivery Services.
DeliveryServiceName is the name of a Delivery Service.
DeliveryServiceNullable represents a Delivery Service as they appeared in version 1.5 - and coincidentally also version 2.0 - of the Traffic Ops API.
DeliveryServiceNullableV30 is the aliased structure that we should be using for all API 3.x Delivery Service operations.
DeliveryServiceRequestCommentsResponseV5 is a Delivery Service Request Comment Response as it appears in version 5 of the Traffic Ops API - it always points to the highest minor version in APIv5.
DeliveryServiceRequestCommentV5 is a Delivery Service Request Comment as it appears in version 5 of the Traffic Ops API - it always points to the highest minor version in APIv5.
DeliveryServiceRequestResponseV4 is the type of a response from Traffic Ops when creating, updating, or deleting a Delivery Service Request using the latest minor version of API version 4.
DeliveryServiceRequestsResponseV4 is the type of a response from Traffic Ops for Delivery Service Requests using the latest minor version of API version 4.
DeliveryServiceRequestV4 is the type of a Delivery Service Request as it appears in API version 4.
DeliveryServiceRequestV5 is the type of a Delivery Service Request as it appears in API version 5.
DeliveryServiceSafeUpdateResponseV4 represents TrafficOps's response to a PUT request to its /api/4.x/deliveryservices/{{ID}}/safe endpoint.
DeliveryServiceServerResponseV5 is the type of a response from Traffic Ops to a GET request to the /deliveryserviceserver endpoint, for the latest minor version of api v5.x.
DeliveryServiceServerV5 is the struct used to represent a delivery service server, in the latest minor version for API 5.x.
DeliveryServicesResponseV4 is the type of a response from the /api/4.x/deliveryservices Traffic Ops endpoint.
DeliveryServiceSSLKeysV4 is the representation of a DeliveryServiceSSLKeys in the latest minor version of version 4 of the Traffic Ops API.
DeliveryServiceV4 is a Delivery Service as it appears in version 4 of the Traffic Ops API - it always points to the highest minor version in APIv4.
DeliveryServiceV5 is the type of a Delivery Service as it appears in the latest minor version of Traffic Ops API version 5.
DivisionResponseV5 is an alias for the latest minor version for the major version 5.
DivisionsResponseV5 is an alias for the latest minor version for the major version 5.
DivisionV5 is an alias for the latest minor version for the major version 5.
DNSSECKeyDSRecordRiak is a DNSSEC key DS record, as stored in Riak.
DNSSECKeys is the DNSSEC keys as stored in Traffic Vault, plus the DS record text.
DNSSECKeysRiak is the structure in which DNSSECKeys are stored in the Riak backend for Traffic Vault.
A DNSSECKeysTrafficVault is a mapping of CDN Names and/or Delivery Service XMLIDs to sets of keys used for DNSSEC with that CDN or Delivery Service.
DNSSECKeysV11 is the DNSSEC keys object stored in Traffic Vault.
A DSMatchType is the Name of a Type of a Regular Expression ("Regex") used by a Delivery Service.
DSRChangeType is an "enumerated" string type that encodes the legal values of a Delivery Service Request's Change Type.
DSServerResponseV4 is the type of a response from Traffic Ops to a request for servers assigned to a Delivery Service - in the latest minor version of API version 4.
DSServerResponseV5 is an alias for the latest minor version of the major version 5.
DSServerV5 is an alias for the latest minor version of the major version 5.
DSType is the Name of a Type used by a Delivery Service.
A DSTypeCategory defines the routing method for a Delivery Service, i.e.
ErrorConstant is used for error messages.
FederationResolverResponseV5 - represents struct response used for the latest minor version associated with APIv5.
FederationResolversResponseV5 - an alias for the Federation Resolver's struct response used for the latest minor version associated with APIv5.
A FederationResolverType is the Name of a Type of a Federation Resolver Mapping.
FederationResolverV5 - is an alias for the Federal Resolver struct response used for the latest minor version associated with APIv5.
Filter is a type of unknown purpose - though it appears related to the removed APIv1 endpoints regarding the servers which are assigned to a Delivery Service, not assigned to a Delivery Service, and eligible for assignment to a Delivery Service.
GeoLimitCountriesType is the type alias that is used to represent the GeoLimitCountries attribute of the DeliveryService struct.
GetTenantsResponseV5 is the type of response from the tenants Traffic Ops endpoint.
IDNoMod type is used to suppress JSON unmarshalling.
InterfaceName is the name of a server interface.
InvalidationJobCreateV4 is an alias for the InvalidationJobCreateV40 struct used for the latest minor version associated with api major version 4.
InvalidationJobV4 is an alias for the InvalidationJobV4 struct used for the latest minor version associated with api major version 4.
No description provided by the author
LocalizationMethod represents an enabled localization method for a Cache Group.
LogsResponseV5 is a list of Logs as a response, for the latest minor version of api 5.x.
LogV5 is the Log structure used by the latest 5.x API version.
OriginDetailResponseV5 is an alias for the latest minor version of the major version 5.
OriginHeaders represents a list of the headers that must be sent to the Origin.
OriginsResponseV5 is an alias for the latest minor version of the major version 5.
OriginV5 is an alias for the latest minor version of the major version 5.
OSVersionsResponse is the JSON representation of the OS versions data for ISO generation.
ParameterName represents the name of a Traffic Ops Parameter.
ParameterNullableV5 is an alias for the latest minor version for the major version 5.
ParametersResponseV5 is an alias for the latest minor version for the major version 5.
ParameterV5 is an alias for the latest minor version for the major version 5.
PhysLocationNullableV5 is an alias for the latest minor version for the major version 5.
PhysLocationResponseV5 is an alias for the latest minor version for the major version 5.
PhysLocationsResponseV5 is an alias for the latest minor version for the major version 5.
PhysLocationV5 is an alias for the latest minor version for the major version 5.
ProfileParameterByNameV5 is the alias to the latest minor version of major version 5.
ProfileParametersAPIResponseV5 is the latest minor version of the major version 5.
ProfileParametersByNamePost is the object posted to profile/name/parameter endpoints.
ProfileParametersNullableV5 is the latest minor version of the major version 5.
ProfileParameterV5 is the latest minor version of the major version 5.
ProfileParamV5 is the latest minor version of the major version 5.
Protocol represents an ATC-supported content delivery protocol.
A QStringIgnore defines how to treat the URL query string for requests for a given Delivery Service's content.
RefreshDNSSECKeysResponse is the type of a response from Traffic Ops to requests made to its /cdns/dnsseckeys/refresh API endpoint.
RegionsResponseV5 is an alias for the latest minor version of the major version 5.
RegionV5 is an alias for the latest minor version of the major version 5.
RequestStatus captures where in the workflow this request is.
RoleV4 is an alias for the latest minor version for the major version 4.
ServerCapabilitiesResponseV5 is an alias for the latest minor version for the major version 5.
ServerCapabilityDetailResponseV5 is an alias for the latest minor version for the major version 5.
ServerCapabilityV4 is an alias for the latest minor version for the major version 4.
ServerCapabilityV5 is an alias for the latest minor version for the major version 5.
ServerNullable represents an ATC server, as returned by the TO API.
ServerServerCapabilitiesResponseV5 is the type of a response from the /api/5.x/server_server_capabilities Traffic Ops endpoint.
ServerServerCapabilityV5 is a ServerServerCapability as it appears in version 5 of the Traffic Ops API - it always points to the highest minor version in APIv5.
ServerUpdateStatusResponseV4 is the type of a response from the Traffic Ops API to a request to its /servers/{{host name}}/update_status endpoint in the latest minor version of API version 4.
ServerUpdateStatusResponseV5 is the type of a response from the Traffic Ops API to a request to its /servers/{{host name}}/update_status endpoint in the latest minor version of API version 5.
ServerUpdateStatusV4 is the type of each entry in the `response` property of the response from Traffic Ops to GET requests made to its /servers/{{host name}}/update_status in the latest minor API v4.0 endpoint.
ServerUpdateStatusV5 is the type of each entry in the `response` property of the response from Traffic Ops to GET requests made to its /servers/{{host name}}/update_status in the latest minor API v5.0 endpoint.
ServerV4 is the representation of a Server in the latest minor version of version 4 of the Traffic Ops API.
ServerV5 is the representation of a Server in the latest minor version of version 5 of the Traffic Ops API.
ServiceCategoriesResponseV5 is the type of a response from the service_categories Traffic Ops endpoint.
ServiceCategoryResponseV5 is the type of a response from the service_categories Traffic Ops endpoint.
ServiceCategoryV5 always points to the type for the latest minor version of serviceCategoryV5x APIv5.
StaticDNSEntriesResponseV5 is a list of StaticDNSEntry as a response, for api version 5.0., for the latest minor version of 5.x.
StaticDNSEntryV5 holds information about a static DNS entry, for the latest minor version of 5.x.
StatsSummaryLastUpdatedAPIResponseV5 is an alias for the latest minor version for the major version 5.
StatsSummaryLastUpdatedV5 is an alias for the latest minor version for the major version 5.
StatsSummaryResponseV5 is an alias for the latest minor version for the major version 5.
StatsSummaryV5 is an alias for the latest minor version for the major version 5.
StatusResponseV5 is the type of a response from the /api/5.x/statuses Traffic Ops endpoint.
StatusV5 is a Status as it appears in version 5 of the Traffic Ops API - it always points to the highest minor version in APIv5.
A SteeringType is the Name of the Type of a Steering Target.
TenantResponseV5 is the type of response from Traffic Ops to a PUT, POST, // or DELETE request made to its /tenants.
TenantV5 always points to the type for the latest minor version of TenantV5x APIv5.
TimeNoMod supports JSON marshalling, but suppresses JSON unmarshalling.
TimeStamp holds the current time with nanosecond precision.
TopologiesResponseV5 is the struct used to represent a response consisting of multiple topologies, for the latest minor version of api 5.x.
TopologyName is the name of a Topology.
TopologyNodeV5 is the struct used to represent topology nodes, for the latest minor version of api 5.x.
TopologyResponseV5 is the struct used to represent a topology response, for the latest minor version of api 5.x.
TopologyV5 is the struct used to represent topologies, for the latest minor version of api 5.x.
TrafficMonitorName is the (short) hostname of a Traffic Monitor peer.
TrafficStatsExclude encodes what parts of a response to a request to a "Traffic Stats" endpoint of the TO API may be omitted.
TrafficStatsOrderable encodes what columns by which the data returned from a Traffic Stats query may be ordered.
TypesResponseV5 is type struct response used for the latest minor version associated with api major version 5.
TypeV5 contains information about a given Type in Traffic Ops used for the latest minor version associated with api major version 5.
URLSigKeys is the type of the `response` property of responses from Traffic Ops to GET requests made to the /deliverservices/xmlId/{{XML ID}}/urlkeys endpoint of its API.
UserRegistrationRequestV4 is the alias for the UserRegistrationRequest for the latest 4.x api version variant.
UserV4 is an alias for the User struct used for the latest minor version associated with api major version 4.