package
5.1.6+incompatible
Repository: https://github.com/apache/trafficcontrol.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
No description provided by the author
CacheStatusFromString returns a CacheStatus from its string representation, or CacheStatusInvalid if the string is not a valid type.
CacheTypeFromString returns a cache type object from its string representation, or CacheTypeInvalid if the string is not a valid type.
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 type.
DSMatchTypeFromString returns a delivery service match type object from its string representation, or DSMatchTypeInvalid if the string is not a valid type.
DSTypeCategoryFromString returns a delivery service type object from its string representation, or DSTypeCategoryInvalid if the string is not a valid type.
DSTypeFromString returns a delivery service type object from its string representation, or DSTypeInvalid if the string is not a valid type.
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.
No description provided by the author
FormatForResponse converts a CacheGroupParametersNullable to CacheGroupParametersResponseNullable in order to format the output the same as the Perl endpoint.
GetHandleErrorsFunc is used to provide an error-handling function.
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.
No description provided by the author
No description provided by the author
No description provided by the author
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.
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.
No description provided by the author
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.
No description provided by the author
StrToThreshold takes a string like ">=42" and returns a HealthThreshold with a Val of `42` and a Comparator of `">="`.
No description provided by the author
No description provided by the author
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CachegroupCoordinateNamePrefix is a string that all cache group coordinate names are prefixed with.
No description provided by the author
No description provided by the author
No description provided by the author
CacheStatusAdminDown represents a cache which has been administratively marked as down, but which should still appear in the CDN (Traffic Server, Traffic Monitor, Traffic Router).
CacheStatusInvalid represents an invalid status enumeration.
CacheStatusOffline represents a cache which has been marked as Offline in Traffic Ops.
CacheStatusOnline represents a cache which has been marked as Online in Traffic Ops, irrespective of monitoring.
CacheStatusReported represents a cache which has been marked as Reported in Traffic Ops.
CacheTypeEdge represents an edge cache.
CacheTypeInvalid represents an cache type enumeration.
CacheTypeMid represents a mid cache.
No description provided by the author
DBError is an error message for database errors.
No description provided by the author
No description provided by the author
default value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DSTypeCategoryDNS represents a DNS delivery service.
DSTypeCategoryHTTP represents an HTTP delivery service.
DSTypeCategoryInvalid represents an invalid delivery service type enumeration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
GlobalConfigFileName is the name of the global Traffic Ops config file.
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
32Mib.
MaxTTL is the maximum value of TTL representable as a time.Duration object, which is used internally by InvalidationJobInput objects to store the TTL.
No description provided by the author
265Kib.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NilTenantError can used when a Tenantable object finds that TentantID in the request is nil.
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RequestStatusComplete -- implemented and locked.
RequestStatusDraft -- newly created; not ready to be reviewed.
RequestStatusInvalid -- invalid state.
RequestStatusPending -- reviewed and locked; ready to be implemented.
RequestStatusRejected -- reviewed, but problems found.
RequestStatusSubmitted -- newly created; ready to be reviewed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
TRAFFIC_STATS_SOURCE is the value of the "source" field in an API response.
TRAFFIC_STATS_VERSION was supposed to be the "API version", but actually the plugin (this route used to be a plugin in Perl) always returned this static value.
No description provided by the author
UseRevalPendingParameterName is the name of a parameter which tells whether or not Traffic Ops should use pending revalidation jobs.
WarnLevel indicates dangerous but non-failing conditions.
# 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 regex.
# 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.
CacheGroupParametersResponse 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 JSON object returned by /api/1.x/federations?all&cdnName=my-cdn-name.
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.
ASNsResponse 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.
No description provided by the author
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.
ATSConfigMetaData contains metadata and information relating to files for a single cache server.
No description provided by the author
No description provided by the author
BypassDestination ...
CacheGroup contains information about a given cache group in Traffic Ops.
CacheGroupDetailResponse is the JSON object returned for a single CacheGroup.
CacheGroupFallback ...
CacheGroupFallbackNullable ...
CacheGroupFallbackResponse is a single CacheGroupFallback response for Update and Create to depict what changed.
CacheGroupFallbacksResponse is a list of CacheGroupFallbacks as a response.
CacheGroupNullable contains information about a given cache group in Traffic Ops.
CacheGroupParameter ...
CacheGroupParameterNullable ...
CacheGroupParameterRequest Cache Group Parameter request body.
CacheGroupParameter ...
CacheGroupParametersList ...
CacheGroupParameterNullable ...
CacheGroupParametersPostResponse Response body when Posting to associate a Parameter with a Cache Group.
CacheGroupParametersResponse is a Cache Group Parameter response body.
CacheGroupParameterResponseNullable ...
No description provided by the author
No description provided by the author
No description provided by the author
CachegroupQueueUpdatesRequest holds info relating to the cachegroups/{{ID}}/queue_update TO route.
CacheGroupsNullableResponse is a response with a list of CacheGroupNullables.
CacheGroupsResponse 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.
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.
CDN ...
CDNConfig includes the name and ID of a single CDN configuration.
No description provided by the author
No description provided by the author
CDNFederationResponse represents a Traffic Ops API response to a request for one or more of a CDN's Federations.
No description provided by the author
CDNNullable ...
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.
No description provided by the author
No description provided by the author
CDNSSLKeys ...
CDNSSLKeysCertificate ...
CDNSSLKeysResponse ...
CommonAPIData contains generic data common to most 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 ...
CoordinateNullable ...
CoordinateResponse is a single Coordinate response for Update and Create to depict what changed.
CoordinatesResponse is a list of Coordinates as a response.
CRConfig is JSON-serializable as the CRConfig used by Traffic Control.
No description provided by the author
No description provided by the author
CRConfigConfig used to be the type of CRConfig's Config field, though CRConfigConfig is no longer used.
TODO: drichardson - reconcile this with the DeliveryService struct in deliveryservices.go.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CreateCDNFederationResponse represents a Traffic Ops API response to a request to create a new Federation for a CDN.
CreateDeliveryServiceNullableResponse ..
CreateDeliveryServiceResponse ..
CreateUserResponse can hold a Traffic Ops API response to a POST request to create a user.
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.
CRSStatsUpdateTracker ...
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 ...
DeleteTenantResponse ...
DeleteUserResponse can theoretically hold a Traffic Ops API response to a DELETE request to update a user.
Deprecated: use DeliveryServiceNullable instead.
No description provided by the author
DeliveryServiceCacheGroup ...
DeliveryServiceCapacity ...
DeliveryServiceCapacityResponse ...
DeliveryServiceDestination ...
DeliveryServiceFailover ...
No description provided by the author
No description provided by the author
DeliveryServiceHealth ...
DeliveryServiceHealthResponse ...
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.
No description provided by the author
No description provided by the author
DeliveryServiceMatch ...
No description provided by the author
DeliveryServiceNullableV11 is a version of the deliveryservice that allows for all fields to be null.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DeliveryServiceRegex ...
DeliveryServiceRegexes ...
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 ...
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.
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.
DeliveryServiceRouting ...
DeliveryServiceRoutingResponse ...
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.
DeliveryServiceSafeUpdateResponse represents Traffic Ops's response to a PUT request to its /api/3.0/deliveryservices/{{ID}}/safe endpoint.
DeliveryServiceServer ...
DeliveryServiceServerResponse ...
No description provided by the author
DeliveryServicesNullableResponse ..
DeliveryServicesRequiredCapability represents an association between a required capability and a delivery service.
DeliveryServicesResponse ..
DeliveryServicesResponseV30 is the type of a response from the /api/3.0/deliveryservices Traffic Ops endpoint.
DeliveryServiceSSLKeys ...
DeliveryServiceSSLKeysCertificate ...
No description provided by the author
DeliveryServiceSSLKeysResponse ...
No description provided by the author
DeliveryServiceState ...
DeliveryServiceStateResponse ...
No description provided by the author
DeliveryServiceV11 contains the information relating to a delivery service that was around in version 1.1 of the API.
No description provided by the author
No description provided by the author
No description provided by the author
Division ...
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.
DivisionsResponse is a list of Divisions as a response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DNSSECKeySetV11 is a DNSSEC key set (ZSK and KSK), as stored in Riak.
No description provided by the author
Domain contains information about a single domain and its profile.
DomainNullable - a struct version that allows for all fields to be null, mostly used by the API side.
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.
No description provided by the author
No description provided by the author
DSServerV11 contains the legacy format for a Delivery Service Server.
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
FederationResolver represents a resolver record for a CDN Federation.
FederationResolverMapping is the set of all resolvers - both IPv4 and IPv6 - for a specific Federation.
FederationUser represents Federation Users.
FederationUserPost represents POST body for assigning Users to Federations.
GenericServerCheck represents a server with some associated meta data presented along with its arbitrary "checks".
GetDeliveryServiceResponse is deprecated use DeliveryServicesResponse...
GetTenantsResponse is the response for a request for a group of tenants.
Hardware ...
HardwareResponse ...
No description provided by the author
No description provided by the author
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.
InvalidationJobInput represents user input intending to create or modify a content invalidation job.
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.
No description provided by the author
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 v1 and v2.
No description provided by the author
LegacyTMConfigResponse was the response to requests made to the cdns/{{Name}}/configs/montoring endpoint of the Traffic Ops API in older API versions.
No description provided by the author
LegacyTrafficMonitorConfig represents TrafficMonitorConfig for ATC versions before 5.0.
LegacyTrafficMonitorConfigMap ...
LegacyTrafficServer ...
Log contains a change that has been made to the Traffic Control system.
LogsResponse is a list of Logs as a response.
MatchList ...
MatchSet ...
MissLocation ...
MonitoringCoordinates holds a coordinate pair for inclusion as a field in TMCacheGroup.
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 server.
OriginDetailResponse is the JSON object returned for a single origin.
OriginsResponse is a list of Origins as a response.
Parameter ...
ParameterNullable - a struct version that allows for all fields to be null, mostly used by the API side.
ParametersResponse ...
PhysLocation contains the physical location of a cache group.
PhysLocationNullable contains the physical location of a cache group.
PhysLocationResponse is a single PhysLocationNullable as a response.
PhysLocationsResponse is a list of PhysLocations as a response.
PhysLocationTrimmed contains only the name of a physical location.
Plugin represents a TO enabled plugin used by Traffic Ops.
PluginsResponse represents the response from Traffic Ops when getting enabled plugins.
No description provided by the author
No description provided by the author
Profile ...
ProfileCopy contains details about the profile created from an existing profile.
ProfileCopyResponse represents the API 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 allows all fields to be 'null'.
ProfileParameter ...
No description provided by the author
No description provided by the author
ProfileParameterNullable ...
No description provided by the author
No description provided by the author
ProfileParameterResponse is a single ProfileParameter response for Create to depict what changed.
ProfileParametersNullable is an object of the form returned by the Traffic Ops /profileparameters endpoint.
No description provided by the author
ProfileParametersResponse ...
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.
ProfileTrimmed ...
Region ...
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.
RegionsResponse ...
No description provided by the author
ResultStatVal is the value of an individual stat returned from a poll.
No description provided by the author
Role ...
RoleResponse is a single Role response for Update and Create to depict what changed.
RolesResponse is a list of Roles as a response.
RoleV11 ...
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.
ServerCapability contains information about a given ServerCapability in Traffic Ops.
ServerCapabilityDetailResponse contains the result data from a POST /server_capabilities request.
Servercheck is a single Servercheck struct for GET response.
ServerCheckColumns is a collection of columns associated with a particular server's "checks".
ServerCheckExtensionID ...
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.
No description provided by the author
No description provided by the author
ServerDetailV30 is the details for a server for API v3.
No description provided by the author
ServerInterfaceInfo is the data associated with a 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.
No description provided by the author
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.
ServerServerCapability 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.
ServersV1Response is a list of Servers for v1 as a response.
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.
No description provided by the author
No description provided by the author
ServerV30 is the representation of a Server in version 3 of the Traffic Ops API.
ServiceCategoriesResponse 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.
SOA (Start of Authority record) defines the SOA record for the CDN's top-level domain.
No description provided by the author
StaticDNS ...
StaticDNSEntriesResponse is a list of StaticDNSEntry as a response.
StaticDNSEntry holds information about a static DNS entry.
StaticDNSEntryNullable holds information about a static DNS entry.
Stats is designed for returning via the API.
StatsSummary ...
StatsSummaryLastUpdated ...
No description provided by the author
StatsSummaryResponse ...
Status is a single Status response for Update and Create to depict what changed.
StatusesResponse 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.
Steering holds information about a steering delivery service.
SteeringFilter is a filter for a target delivery service.
SteeringSteeringTarget is a target delivery service of a steering delivery service.
No description provided by the author
No description provided by the author
SystemInfo can hold arbitrary system information (e.g., as a Traffic Ops API response).
Tenant ...
TenantAlert ...
TenantNullable ...
TenantResponse is the response to a create/update.
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.
TOExtensionID ...
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.
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.
TopologiesResponse models the JSON object returned for a single topology in a response.
TrafficCacheStatsConfig represents the configuration of a request made to Traffic Stats for caches.
TrafficDSStatsConfig represents the configuration of a request made to Traffic Stats for delivery services.
TrafficDSStatsResponse represents a response from the deliveryservice_stats` "Traffic Stats" endpoints.
TrafficDSStatsResponseV1 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.
TrafficRouter ...
TrafficRouterConfig is the json unmarshalled without any changes note all structs are local to this file _except_ the TrafficRouterConfig struct.
TrafficRouterConfigMap ...
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 Different then TrafficStatsCDNStats as it omits Capacity.
TRDeliveryService ..
TTLS ...
Type contains information about a given Type in Traffic Ops.
TypeNullable contains information about a given Type in Traffic Ops.
TypesResponse ...
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 ..
UpdateDeliveryServiceResponse ..
UpdateUserResponse can hold a Traffic Ops API response to a PUT request to update a user.
User fields in v14 have been updated to be nullable.
No description provided by the author
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.
UserDeliveryServiceDeleteResponse can hold a Traffic Ops API response to a request to remove a delivery service from a user.
No description provided by the author
No description provided by the author
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.
UsersResponse can hold a Traffic Ops API response to a request to get a list of users.
UsersResponseV13 is the Traffic Ops API version 1.3 variant of UserResponse.
UserToken represents a request payload containing a UUID token for authentication.
UserV13 contains non-nullable TO user information.
# Interfaces
IAllFederation is an interface for the disparate objects returned by /api/1.x/federations?all.
# Type aliases
AlertLevel is used for specifying or comparing different levels of alerts.
No description provided by the author
CacheGroupName is the name of a CDN cachegroup.
CacheName is the hostname of a CDN cache.
CacheStatus represents the Traffic Server status set in Traffic Ops (online, offline, admin_down, reported).
CacheType is the type (or tier) of a CDN cache.
CDNDNSSECGenerateReqDate is the date accepted by CDNDNSSECGenerateReq.
CDNName is the name of a CDN in Traffic Control.
CDNQueueUpdateRequest encodes the request data for the POST cdns/{{ID}}/queue_update endpoint.
No description provided by the author
ConfigFileName represents the name of a Traffic Ops config file.
No description provided by the author
No description provided by the author
DeepCachingType represents a Delivery Service's deep caching type.
DeliveryServiceFederationResolverMappingRequest is the format of a request to create (or modify) the Federation Resolver mappings of one or more Delivery Services.
No description provided by the author
DeliveryServiceName is the name of a CDN delivery service.
Deprecated: Use versioned structures only from now on.
DeliveryServiceNullableV30 is the aliased structure that we should be using for all api 3.x delivery structure operations This type should always alias the latest 3.x minor version struct.
DNSSECKeyDSRecordRiak is a DNSSEC key DS record, as stored in Riak.
DNSSECKeys is the DNSSEC keys as stored in Riak, plus the DS record text.
No description provided by the author
No description provided by the author
No description provided by the author
DSType is the Delivery Service type.
DSTypeCategory is the Delivery Service type category: HTTP or DNS.
ErrorConstant is used for error messages.
No description provided by the author
No description provided by the author
IDNoMod type is used to suppress JSON unmarshalling.
InterfaceName is the name of the server interface.
LocalizationMethod represents an enabled localization method for a cachegroup.
OriginHeaders represents a list of the headers that must be sent to the Origin.
OSVersionsResponse is the JSON representation of the OS versions data for ISO generation.
ParameterName represents the name of a Traffic Ops parameter meant to belong in a Traffic Ops config file.
ProfileParametersByNamePost is the object posted to profile/name/parameter endpoints.
Protocol represents an ATC-supported content delivery protocol.
QStringIgnore is an entry in the delivery_service table qstring_ignore column, and represents how to treat the URL query string for requests to that delivery service.
RequestStatus captures where in the workflow this request is.
ServerNullable represents an ATC server, as returned by the TO API.
No description provided by the author
TimeNoMod supported JSON marshalling, but suppresses JSON unmarshalling.
TimeStamp holds the current time with nanosecond precision.
TopologyName is the name of a topology of cachegroups.
TrafficMonitorName is the 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.
No description provided by the author