client

package
v5.1.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 22, 2021 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause, + 1 more Imports: 20 Imported by: 0

README

TO Client Library Golang

Getting Started

  1. Obtain the latest version of the library

go get github.com/apache/trafficcontrol/traffic_ops/client

  1. Get a basic TO session started and fetch a list of CDNs
package main

import (
	"fmt"
	"os"
	"time"

	"github.com/apache/trafficcontrol/lib/go-tc"
	toclient "github.com/apache/trafficcontrol/traffic_ops/client"
)

const TOURL = "http://localhost"
const TOUser = "user"
const TOPassword = "password"
const AllowInsecureConnections = true
const UserAgent = "MySampleApp"
const UseClientCache = false
const TrafficOpsRequestTimeout = time.Second * time.Duration(10)

func main() {
	session, remoteaddr, err := toclient.LoginWithAgent(
		TOURL,
		TOUser,
		TOPassword,
		AllowInsecureConnections,
		UserAgent,
		UseClientCache,
		TrafficOpsRequestTimeout)
	if err != nil {
		fmt.Printf("An error occurred while logging in:\n\t%v\n", err)
		os.Exit(1)
	}
	fmt.Println("Connected to: " + remoteaddr.String())
	var cdns []tc.CDN
	cdns, _, err = session.GetCDNsWithHdr(nil)
	if err != nil {
		fmt.Printf("An error occurred while getting cdns:\n\t%v\n", err)
		os.Exit(1)
	}
	for _, cdn := range cdns {
		fmt.Println(cdn.Name)
	}
}

Documentation

Overview

Package client implements methods for interacting with the Traffic Ops API.

Warning: Using the un-versioned import path ("client") is deprecated, and the ability to do so will be removed in ATC 6.0 - please use versioned client imports (e.g. "v3-client") instead

Package client provides Go bindings to the Traffic Ops RPC API.

Index

Constants

View Source 
const (
	// API_ABOUT is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_ABOUT = apiBase + "/about"

	APIAbout = "/about"
)
View Source 
const (
	// API_ASNS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_ASNS = apiBase + "/asns"

	APIASNs = "/asns"
)
View Source 
const (
	// DEPRECATED: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_CACHEGROUPS = apiBase + "/cachegroups"

	APICachegroups = "/cachegroups"
)
View Source 
const (
	// API_CACHEGROUPPARAMETERS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_CACHEGROUPPARAMETERS = apiBase + "/cachegroupparameters"

	APICachegroupParameters = "/cachegroupparameters"
)
View Source 
const (
	// API_CDNS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_CDNS = apiBase + "/cdns"

	APICDNs = "/cdns"
)
View Source 
const (
	// API_COORDINATES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_COORDINATES = apiBase + "/coordinates"

	APICoordinates = "/coordinates"
)
View Source 
const (
	// API_SNAPSHOT is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_SNAPSHOT = apiBase + "/snapshot"

	APISnapshot = "/snapshot"
)
View Source 
const (
	// API_DELIVERY_SERVICES is the API path on which Traffic Ops serves Delivery Service
	// information. More specific information is typically found on sub-paths of this.
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICES = apiBase + "/deliveryservices"

	// API_DELIVERY_SERVICE_ID is the API path on which Traffic Ops serves information about
	// a specific Delivery Service identified by an integral, unique identifier. It is
	// intended to be used with fmt.Sprintf to insert its required path parameter (namely the ID
	// of the Delivery Service of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_id.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICE_ID = API_DELIVERY_SERVICES + "/%v"

	// API_DELIVERY_SERVICE_HEALTH is the API path on which Traffic Ops serves information about
	// the 'health' of a specific Delivery Service identified by an integral, unique identifier. It is
	// intended to be used with fmt.Sprintf to insert its required path parameter (namely the ID
	// of the Delivery Service of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_id_health.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICE_HEALTH = API_DELIVERY_SERVICE_ID + "/health"

	// API_DELIVERY_SERVICE_CAPACITY is the API path on which Traffic Ops serves information about
	// the 'capacity' of a specific Delivery Service identified by an integral, unique identifier. It is
	// intended to be used with fmt.Sprintf to insert its required path parameter (namely the ID
	// of the Delivery Service of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_id_capacity.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICE_CAPACITY = API_DELIVERY_SERVICE_ID + "/capacity"

	// API_DELIVERY_SERVICE_ELIGIBLE_SERVERS is the API path on which Traffic Ops serves information about
	// the servers which are eligible to be assigned to a specific Delivery Service identified by an integral,
	// unique identifier. It is intended to be used with fmt.Sprintf to insert its required path parameter
	// (namely the ID of the Delivery Service of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_id_servers_eligible.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICE_ELIGIBLE_SERVERS = API_DELIVERY_SERVICE_ID + "/servers/eligible"

	// API_DELIVERY_SERVICES_SAFE_UPDATE is the API path on which Traffic Ops provides the functionality to
	// update the "safe" subset of properties of a Delivery Service identified by an integral, unique
	// identifer. It is intended to be used with fmt.Sprintf to insert its required path parameter
	// (namely the ID of the Delivery Service of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_id_safe.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICES_SAFE_UPDATE = API_DELIVERY_SERVICE_ID + "/safe"

	// API_DELIVERY_SERVICE_XMLID_SSL_KEYS is the API path on which Traffic Ops serves information about
	// and functionality relating to the SSL keys used by a Delivery Service identified by its XMLID. It is
	// intended to be used with fmt.Sprintf to insert its required path parameter (namely the XMLID
	// of the Delivery Service of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_xmlid_xmlid_sslkeys.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICE_XMLID_SSL_KEYS = API_DELIVERY_SERVICES + "/xmlId/%s/sslkeys"

	// API_DELIVERY_SERVICE_GENERATE_SSL_KEYS is the API path on which Traffic Ops will generate new SSL keys
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_sslkeys_generate.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICE_GENERATE_SSL_KEYS = API_DELIVERY_SERVICES + "/sslkeys/generate"

	// API_DELIVERY_SERVICE_URI_SIGNING_KEYS is the API path on which Traffic Ops serves information
	// about and functionality relating to the URI-signing keys used by a Delivery Service identified
	// by its XMLID. It is intended to be used with fmt.Sprintf to insert its required path parameter
	// (namely the XMLID of the Delivery Service of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_xmlid_urisignkeys.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICES_URI_SIGNING_KEYS = API_DELIVERY_SERVICES + "/%s/urisignkeys"

	// API_DELIVERY_SERVICES_URL_SIGNING_KEYS is the API path on which Traffic Ops serves information
	// about and functionality relating to the URL-signing keys used by a Delivery Service identified
	// by its XMLID. It is intended to be used with fmt.Sprintf to insert its required path parameter
	// (namely the XMLID of the Delivery Service of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_xmlid_xmlid_urlkeys.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICES_URL_SIGNING_KEYS = API_DELIVERY_SERVICES + "/xmlid/%s/urlkeys"

	// API_DELIVERY_SERVICES_REGEXES is the API path on which Traffic Ops serves Delivery Service
	// 'regex' (Regular Expression) information.
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_regexes.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICES_REGEXES = apiBase + "/deliveryservices_regexes"

	// API_SERVER_DELIVERY_SERVICES is the API path on which Traffic Ops serves functionality
	// related to the associations a specific server and its assigned Delivery Services. It is
	// intended to be used with fmt.Sprintf to insert its required path parameter (namely the ID
	// of the server of interest).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/servers_id_deliveryservices.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_SERVER_DELIVERY_SERVICES = apiBase + "/servers/%d/deliveryservices"

	// API_DELIVERY_SERVICE_SERVER is the API path on which Traffic Ops serves functionality related
	// to the associations between Delivery Services and their assigned Server(s).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryserviceserver.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICE_SERVER = apiBase + "/deliveryserviceserver"

	// API_DELIVERY_SERVICES_SERVERS is the API path on which Traffic Ops serves functionality related
	// to the associations between a Delivery Service and its assigned Server(s).
	// See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_xmlid_servers.html
	//
	// Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICES_SERVERS = apiBase + "/deliveryservices/%s/servers"

	APIDeliveryServices               = "/deliveryservices"
	APIDeliveryServiceId              = APIDeliveryServices + "/%v"
	APIDeliveryServiceHealth          = APIDeliveryServiceId + "/health"
	APIDeliveryServiceCapacity        = APIDeliveryServiceId + "/capacity"
	APIDeliveryServiceEligibleServers = APIDeliveryServiceId + "/servers/eligible"
	APIDeliveryServicesSafeUpdate     = APIDeliveryServiceId + "/safe"
	APIDeliveryServiceXmlidSslKeys    = APIDeliveryServices + "/xmlId/%s/sslkeys"
	APIDeliveryServiceGenerateSslKeys = APIDeliveryServices + "/sslkeys/generate"
	APIDeliveryServicesUriSigningKeys = APIDeliveryServices + "/%s/urisignkeys"
	APIDeliveryServicesUrlSigningKeys = APIDeliveryServices + "/xmlid/%s/urlkeys"
	APIDeliveryServicesRegexes        = "/deliveryservices_regexes"
	APIServerDeliveryServices         = "/servers/%d/deliveryservices"
	APIDeliveryServiceServer          = "/deliveryserviceserver"
	APIDeliveryServicesServers        = "/deliveryservices/%s/servers"
)

These are the API endpoints used by the various Delivery Service-related client methods.

View Source 
const (
	// API_DS_REGEXES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	// See: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/deliveryservices_id_regexes.html
	API_DS_REGEXES = apiBase + "/deliveryservices/%d/regexes"

	APIDSRegexes = "/deliveryservices/%d/regexes"
)
View Source 
const (
	// API_DELIVERY_SERVICE_REQUEST_COMMENTS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICE_REQUEST_COMMENTS = apiBase + "/deliveryservice_request_comments"

	APIDeliveryServiceRequestComments = "/deliveryservice_request_comments"
)
View Source 
const (
	// API_DS_REQUESTS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DS_REQUESTS = apiBase + "/deliveryservice_requests"

	APIDSRequests = "/deliveryservice_requests"
)
View Source 
const (
	// API_DELIVERY_SERVICES_REQUIRED_CAPABILITIES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DELIVERY_SERVICES_REQUIRED_CAPABILITIES = apiBase + "/deliveryservices_required_capabilities"

	APIDeliveryServicesRequiredCapabilities = "/deliveryservices_required_capabilities"
)
View Source 
const (
	// API_DIVISIONS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_DIVISIONS = apiBase + "/divisions"

	APIDivisions = "/divisions"
)
View Source 
const (
	// API_OSVERSIONS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_OSVERSIONS = apiBase + "/osversions"

	APIOSVersions = "/osversions"
)
View Source 
const (
	// DEPRECATED: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_LOGS = apiBase + "/logs"

	APILogs = "/logs"
)
View Source 
const (
	// API_ORIGINS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_ORIGINS = apiBase + "/origins"

	APIOrigins = "/origins"
)
View Source 
const (
	// API_PARAMETERS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_PARAMETERS = apiBase + "/parameters"

	APIParameters = "/parameters"
)
View Source 
const (
	// API_PHYS_LOCATIONS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_PHYS_LOCATIONS = apiBase + "/phys_locations"

	APIPhysLocations = "/phys_locations"
)
View Source 
const (
	// API_PING is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_PING = apiBase + "/ping"

	APIPing = "/ping"
)
View Source 
const (
	// API_PROFILES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_PROFILES = apiBase + "/profiles"

	// API_PROFILES_NAME_PARAMETERS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_PROFILES_NAME_PARAMETERS = API_PROFILES + "/name/%s/parameters"

	APIProfiles               = "/profiles"
	APIProfilesNameParameters = APIProfiles + "/name/%s/parameters"
)
View Source 
const (
	// DEPRECATED: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_PROFILE_PARAMETERS = apiBase + "/profileparameters"
	ProfileIdQueryParam    = "profileId"
	ParameterIdQueryParam  = "parameterId"

	APIProfileParameters = "/profileparameters"
)
View Source 
const (
	// API_REGIONS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_REGIONS = apiBase + "/regions"

	APIRegions = "/regions"
)
View Source 
const (
	// API_ROLES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_ROLES = apiBase + "/roles"

	APIRoles = "/roles"
)
View Source 
const (
	// API_SERVERS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_SERVERS = apiBase + "/servers"
	// API_SERVERS_DETAILS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_SERVERS_DETAILS = apiBase + "/servers/details"
	// API_SERVER_ASSIGN_DELIVERY_SERVICES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_SERVER_ASSIGN_DELIVERY_SERVICES = API_SERVER_DELIVERY_SERVICES + "?replace=%t"

	APIServers                      = "/servers"
	APIServersDetails               = "/servers/details"
	APIServerAssignDeliveryServices = APIServerDeliveryServices + "?replace=%t"
)
View Source 
const (
	// API_SERVER_SERVER_CAPABILITIES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_SERVER_SERVER_CAPABILITIES = apiBase + "/server_server_capabilities"

	APIServerServerCapabilities = "/server_server_capabilities"
)
View Source 
const (
	// API_SERVER_CAPABILITIES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_SERVER_CAPABILITIES = apiBase + "/server_capabilities"

	APIServerCapabilities = "/server_capabilities"
)
View Source 
const (
	// API_SERVICE_CATEGORIES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_SERVICE_CATEGORIES = apiBase + "/service_categories"

	APIServiceCategories = "/service_categories"
)
View Source 
const (
	// API_STATIC_DNS_ENTRIES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_STATIC_DNS_ENTRIES = apiBase + "/staticdnsentries"

	APIStaticDNSEntries = "/staticdnsentries"
)
View Source 
const (
	// API_STATS_SUMMARY is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_STATS_SUMMARY = apiBase + "/stats_summary"

	APIStatsSummary = "/stats_summary"
)
View Source 
const (
	// API_STATUSES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_STATUSES = apiBase + "/statuses"

	APIStatuses = "/statuses"
)
View Source 
const (
	// DEPRECATED: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.
	API_TYPES = apiBase + "/types"

	APITypes = "/types"
)
View Source 
const APICDNMonitoringConfig = "/cdns/%s/configs/monitoring"
View Source 
const APICapabilities = "/capabilities"
View Source 
const APIFederations = apiBase + "/federations"

APIFederations is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.

View Source 
const APIFederationsPath = "/federations"
View Source 
const APIServercheck = "/servercheck"
View Source 
const APITOExtension = "/servercheck/extensions"
View Source 
const APITenantID = APITenants + "/%v"
View Source 
const APITenants = "/tenants"
View Source 
const APITopologies = "/topologies"
View Source 
const API_CAPABILITIES = apiBase + "/capabilities"

API_CAPABILITIES is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.

View Source 
const API_CDN_MONITORING_CONFIG = apiBase + "/cdns/%s/configs/monitoring"

API_CDN_MONITORING_CONFIG is the API path on which Traffic Ops serves the CDN monitoring configuration information. It is meant to be used with fmt.Sprintf to insert the necessary path parameters (namely the Name of the CDN of interest). See Also: https://traffic-control-cdn.readthedocs.io/en/latest/api/v3/cdns_name_configs_monitoring.html

DEPRECATED: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.

View Source 
const API_SERVERCHECK = apiBase + "/servercheck"

API_SERVERCHECK is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.

View Source 
const API_TENANTS = apiBase + "/tenants"

API_TENANTS is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.

View Source 
const API_TENANT_ID = API_TENANTS + "/%s"

API_TENANT_ID is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.

View Source 
const API_TO_EXTENSION = apiBase + "/servercheck/extensions"

API_TO_EXTENSION is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.

View Source 
const ApiTopologies = apiBase + "/topologies"

ApiTopologies is Deprecated: will be removed in the next major version. Be aware this may not be the URI being requested, for clients created with Login and ClientOps.ForceLatestAPI false.

View Source 
const CacheHitStatusExpired = CacheHitStatus("expired")

CacheHitStatusExpired is deprecated and will be removed in the next major version.

View Source 
const CacheHitStatusHit = CacheHitStatus("hit")

CacheHitStatusHit is deprecated and will be removed in the next major version.

View Source 
const CacheHitStatusInvalid = CacheHitStatus("")

CacheHitStatusInvalid is deprecated and will be removed in the next major version.

View Source 
const CacheHitStatusMiss = CacheHitStatus("miss")

CacheHitStatusMiss is deprecated and will be removed in the next major version.

View Source 
const DefaultAPIVersionCheckInterval = time.Second * 60
View Source 
const DefaultTimeout = time.Second * 30

Variables

View Source 
var ErrNotImplemented = errors.New("Traffic Ops Server returned 'Not Implemented', this client is probably newer than Traffic Ops, and you probably need to either upgrade Traffic Ops, or use a client whose version matches your Traffic Ops version.")

ErrNotImplemented is returned when Traffic Ops returns a 501 Not Implemented Users should check ErrIsNotImplemented rather than comparing directly, in case context was added.

Functions

func ErrIsNotImplemented 

func ErrIsNotImplemented(err error) bool

func Login 

func Login(url, user, pass string, opts ClientOpts) (*Session, ReqInf, error)

Login authenticates with Traffic Ops and returns the client object.

Returns the logged in client, the remote address of Traffic Ops which was translated and used to log in, and any error. If the error is not nil, the remote address may or may not be nil, depending whether the error occurred before the login request.

See ClientOpts for details about options, which options are required, and how they behave.

Types

type CacheHitStatus 

type CacheHitStatus string

CacheHitStatus is deprecated and will be removed in the next major version.

func StringToCacheHitStatus 

func StringToCacheHitStatus(s string) CacheHitStatus

StringToCacheHitStatus is deprecated and will be removed in the next major version.

func (CacheHitStatus) String 

func (s CacheHitStatus) String() string

String is deprecated and will be removed in the next major version.

type ClientOpts 

type ClientOpts struct {
	// ForceLatestAPI will cause Login to return an error if the latest minor API in the client
	// is not supported by the Traffic Ops Server.
	//
	// Note this was the behavior of all Traffic Ops client functions prior to the Login function.
	//
	// If this is false or unset, login will determine the latest minor version supported, and use that for all requests.
	//
	// Be aware, this means client fields unknown to the server will always be default-initialized.
	// For example, suppose the field Foo was added in API 3.1, the client code is 3.1, and the server is 3.0.
	// Then, the field Foo will always be nil or the default value.
	// Client applications must understand this, and code processing the new feature Foo must be able to
	// process default or nil values, understanding they may indicate a server version before the feature was added.
	//
	ForceLatestAPI bool

	// Insecure is whether to ignore HTTPS certificate errors with Traffic Ops.
	// Setting this on production systems is strongly discouraged.
	Insecure bool

	// RequestTimeout is the HTTP timeout for Traffic Ops requests.
	// If 0 or not explicitly set, DefaultTimeout will be used.
	RequestTimeout time.Duration

	// UserAgent is the HTTP User Agent to use set when communicating with Traffic Ops.
	// This field is required, and Login will fail if it is unset or the empty string.
	UserAgent string

	// APIVersionCheckInterval is how often to try a newer Traffic Ops API Version.
	// This allows clients to get new Traffic Ops features after Traffic Ops is upgraded
	// without requiring a restart or new client.
	//
	// If 0 or not explicitly set, DefaultAPIVersionCheckInterval will be used.
	// To disable, set to a very high value (like 100 years).
	//
	// This has no effect if ForceLatestAPI is true.
	APIVersionCheckInterval time.Duration
}

ClientOpts is the options to configure the creation of the Client.

This exists to allow adding new features without a breaking change to the Login function. Users should understand this, and understand that upgrading their library may result in new options that their application doesn't know to use. New fields should always behave as-before if their value is the default.

type HTTPError 

type HTTPError struct {
	HTTPStatusCode int
	HTTPStatus     string
	URL            string
	Body           string
}

HTTPError is returned on Update Session failure.

func (*HTTPError) Error 

func (e *HTTPError) Error() string

Error implements the error interface for our customer error type.

type MidReqF 

type MidReqF func(ReqF) ReqF

type OuterResponse 

type OuterResponse struct {
	Response json.RawMessage `json:"response"`
}

type ReqF 

type ReqF func(to *Session, method string, path string, body interface{}, header http.Header, response interface{}) (ReqInf, error)

type ReqInf 

type ReqInf struct {
	// CacheHitStatus is deprecated and will be removed in the next major version.
	CacheHitStatus CacheHitStatus
	RemoteAddr     net.Addr
	StatusCode     int
}

type Session 

type Session struct {
	UserName     string
	Password     string
	URL          string
	Client       *http.Client
	UserAgentStr string
	// contains filtered or unexported fields
}

Session ...

func LoginWithAgent 

func LoginWithAgent(toURL string, toUser string, toPasswd string, insecure bool, userAgent string, useCache bool, requestTimeout time.Duration) (*Session, net.Addr, error)

Login to traffic_ops, the response should set the cookie for this session automatically. Start with 

to := traffic_ops.Login("user", "passwd", true)

subsequent calls like to.GetData("datadeliveryservice") will be authenticated. Returns the logged in client, the remote address of Traffic Ops which was translated and used to log in, and any error. If the error is not nil, the remote address may or may not be nil, depending whether the error occurred before the login request. The useCache argument is ignored. It exists to avoid breaking compatibility, and does not exist in newer functions.

func LoginWithToken 

func LoginWithToken(toURL string, token string, insecure bool, userAgent string, useCache bool, requestTimeout time.Duration) (*Session, net.Addr, error)

func LogoutWithAgent 

func LogoutWithAgent(toURL string, toUser string, toPasswd string, insecure bool, userAgent string, useCache bool, requestTimeout time.Duration) (*Session, net.Addr, error)

Logout of Traffic Ops. The useCache argument is ignored. It exists to avoid breaking compatibility, and does not exist in newer functions.

func NewNoAuthSession 

func NewNoAuthSession(toURL string, insecure bool, userAgent string, useCache bool, requestTimeout time.Duration) *Session

NewNoAuthSession returns a new Session without logging in this can be used for querying unauthenticated endpoints without requiring a login The useCache argument is ignored. It exists to avoid breaking compatibility, and does not exist in newer functions.

func NewSession 

func NewSession(user, password, url, userAgent string, client *http.Client, useCache bool) *Session

func (*Session) APIBase 

func (sn *Session) APIBase() string

APIBase returns the base API string for HTTP requests, such as /api/3.1.

func (*Session) APIVersion 

func (sn *Session) APIVersion() string

APIVersion is the version of the Traffic Ops API this client will use for requests. If the client was created with any function except Login, or with UseLatestSupportedAPI false, this will be LatestAPIVersion(). Otherwise, it will be the version dynamically determined to be the latest the Traffic Ops Server supports.

func (*Session) AddFederationResolverMappingsForCurrentUser 

func (to *Session) AddFederationResolverMappingsForCurrentUser(mappings tc.DeliveryServiceFederationResolverMappingRequest) (tc.Alerts, ReqInf, error)

AddFederationResolverMappingsForCurrentUser adds Federation Resolver mappings to one or more Delivery Services for the current user.

func (*Session) AllFederations deprecated 

func (to *Session) AllFederations() ([]tc.AllDeliveryServiceFederationsMapping, ReqInf, error)

Deprecated: AllFederations will be removed in 6.0. Use AllFederationsWithHdr.

func (*Session) AllFederationsForCDN deprecated 

func (to *Session) AllFederationsForCDN(cdnName string) ([]tc.AllDeliveryServiceFederationsMapping, ReqInf, error)

Deprecated: AllFederationsForCDN will be removed in 6.0. Use AllFederationsForCDNWithHdr.

func (*Session) AllFederationsForCDNWithHdr 

func (to *Session) AllFederationsForCDNWithHdr(cdnName string, header http.Header) ([]tc.AllDeliveryServiceFederationsMapping, ReqInf, error)

func (*Session) AllFederationsWithHdr 

func (to *Session) AllFederationsWithHdr(header http.Header) ([]tc.AllDeliveryServiceFederationsMapping, ReqInf, error)

func (*Session) AssignDeliveryServiceIDsToServerID 

func (to *Session) AssignDeliveryServiceIDsToServerID(server int, dsIDs []int, replace bool) (tc.Alerts, ReqInf, error)

AssignDeliveryServiceIDsToServerID assigns a set of Delivery Services to a single server, optionally replacing any and all existing assignments. 'server' should be the requested server's ID, 'dsIDs' should be a slice of the requested Delivery Services' IDs. If 'replace' is 'true', existing assignments to the server will be replaced.

func (*Session) AssignFederationFederationResolver 

func (to *Session) AssignFederationFederationResolver(fedID int, resolverIDs []int, replace bool) (tc.AssignFederationFederationResolversResponse, ReqInf, error)

AssignFederationFederationResolver creates the Federation Resolver 'fr'.

func (*Session) AssignServersToDeliveryService 

func (to *Session) AssignServersToDeliveryService(servers []string, xmlId string) (tc.Alerts, ReqInf, error)

AssignServersToDeliveryService assigns the given list of servers to the delivery service with the given xmlId.

func (*Session) CopyProfile 

func (to *Session) CopyProfile(p tc.ProfileCopy) (tc.ProfileCopyResponse, ReqInf, error)

CopyProfile creates a new profile from an existing profile.

func (*Session) CreateASN 

func (to *Session) CreateASN(entity tc.ASN) (tc.Alerts, ReqInf, error)

CreateASN creates a ASN

func (*Session) CreateCDN 

func (to *Session) CreateCDN(cdn tc.CDN) (tc.Alerts, ReqInf, error)

CreateCDN creates a CDN.

func (*Session) CreateCDNFederationByName 

func (to *Session) CreateCDNFederationByName(f tc.CDNFederation, CDNName string) (*tc.CreateCDNFederationResponse, ReqInf, error)

func (*Session) CreateCacheGroupNullable 

func (to *Session) CreateCacheGroupNullable(cachegroup tc.CacheGroupNullable) (*tc.CacheGroupDetailResponse, ReqInf, error)

Create a CacheGroup.

func (*Session) CreateCacheGroupParameter 

func (to *Session) CreateCacheGroupParameter(cacheGroupID, parameterID int) (*tc.CacheGroupParametersPostResponse, ReqInf, error)

CreateCacheGroupParameter Associates a Parameter with a Cache Group

func (*Session) CreateCoordinate 

func (to *Session) CreateCoordinate(coordinate tc.Coordinate) (tc.Alerts, ReqInf, error)

Create a Coordinate

func (*Session) CreateDeliveryServiceNullable deprecated 

func (to *Session) CreateDeliveryServiceNullable(ds *tc.DeliveryServiceNullable) (*tc.CreateDeliveryServiceNullableResponse, error)

CreateDeliveryServiceNullable creates the DeliveryService it's passed.

Warning: This method coerces its returned data into an APIv1.5 format, and only accepts input in an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, CreateDeliveryServiceV30.

func (*Session) CreateDeliveryServiceRequest 

func (to *Session) CreateDeliveryServiceRequest(dsr tc.DeliveryServiceRequest) (tc.Alerts, ReqInf, error)

CreateDeliveryServiceRequest creates a Delivery Service Request.

func (*Session) CreateDeliveryServiceRequestComment 

func (to *Session) CreateDeliveryServiceRequestComment(comment tc.DeliveryServiceRequestComment) (tc.Alerts, ReqInf, error)

Create a delivery service request comment

func (*Session) CreateDeliveryServiceServers 

func (to *Session) CreateDeliveryServiceServers(dsID int, serverIDs []int, replace bool) (*tc.DSServerIDs, ReqInf, error)

CreateDeliveryServiceServers associates the given servers with the given delivery services. If replace is true, it deletes any existing associations for the given delivery service.

func (*Session) CreateDeliveryServiceV30 

func (to *Session) CreateDeliveryServiceV30(ds tc.DeliveryServiceNullableV30) (tc.DeliveryServiceNullableV30, ReqInf, error)

CreateDeliveryServiceV30 creates the Delivery Service it's passed.

func (*Session) CreateDeliveryServicesRequiredCapability 

func (to *Session) CreateDeliveryServicesRequiredCapability(capability tc.DeliveryServicesRequiredCapability) (tc.Alerts, ReqInf, error)

CreateDeliveryServicesRequiredCapability assigns a Required Capability to a Delivery Service

func (*Session) CreateDivision 

func (to *Session) CreateDivision(division tc.Division) (tc.Alerts, ReqInf, error)

Create a Division

func (*Session) CreateFederationDeliveryServices 

func (to *Session) CreateFederationDeliveryServices(federationID int, deliveryServiceIDs []int, replace bool) (ReqInf, error)

func (*Session) CreateFederationResolver 

func (to *Session) CreateFederationResolver(fr tc.FederationResolver) (tc.Alerts, ReqInf, error)

CreateFederationResolver creates the Federation Resolver 'fr'.

func (*Session) CreateFederationUsers 

func (to *Session) CreateFederationUsers(federationID int, userIDs []int, replace bool) (tc.Alerts, ReqInf, error)

GetFederationUsers Associates the given Users' IDs to a Federation

func (*Session) CreateInvalidationJob 

func (to *Session) CreateInvalidationJob(job tc.InvalidationJobInput) (tc.Alerts, ReqInf, error)

Creates a new Content Invalidation Job

func (*Session) CreateMultipleParameters 

func (to *Session) CreateMultipleParameters(pls []tc.Parameter) (tc.Alerts, ReqInf, error)

CreateMultipleParameters performs a POST to create multiple Parameters at once.

func (*Session) CreateMultipleProfileParameters 

func (to *Session) CreateMultipleProfileParameters(pps []tc.ProfileParameter) (tc.Alerts, ReqInf, error)

CreateMultipleProfileParameters creates multiple ProfileParameters at once.

func (*Session) CreateOrigin 

func (to *Session) CreateOrigin(origin tc.Origin) (*tc.OriginDetailResponse, ReqInf, error)

Create an Origin

func (*Session) CreateParameter 

func (to *Session) CreateParameter(pl tc.Parameter) (tc.Alerts, ReqInf, error)

CreateParameter performs a POST to create a Parameter.

func (*Session) CreatePhysLocation 

func (to *Session) CreatePhysLocation(pl tc.PhysLocation) (tc.Alerts, ReqInf, error)

CreatePhysLocation creates a PhysLocation.

func (*Session) CreateProfile 

func (to *Session) CreateProfile(pl tc.Profile) (tc.Alerts, ReqInf, error)

CreateProfile creates a Profile.

func (*Session) CreateProfileParameter 

func (to *Session) CreateProfileParameter(pp tc.ProfileParameter) (tc.Alerts, ReqInf, error)

Create a ProfileParameter

func (*Session) CreateRegion 

func (to *Session) CreateRegion(region tc.Region) (tc.Alerts, ReqInf, error)

CreateRegion creates a Region.

func (*Session) CreateRole 

func (to *Session) CreateRole(role tc.Role) (tc.Alerts, ReqInf, int, error)

CreateRole creates a Role.

func (*Session) CreateServer 

func (to *Session) CreateServer(server tc.Server) (tc.Alerts, ReqInf, error)

CreateServer creates a Server. Deprecated: CreateServer will be removed in 6.0. Use CreateServerWithHdr.

func (*Session) CreateServerCapability 

func (to *Session) CreateServerCapability(sc tc.ServerCapability) (*tc.ServerCapabilityDetailResponse, ReqInf, error)

CreateServerCapability creates a server capability and returns the response.

func (*Session) CreateServerCheckExtension 

func (to *Session) CreateServerCheckExtension(ServerCheckExtension tc.ServerCheckExtensionNullable) (tc.Alerts, ReqInf, error)

CreateServerCheckExtension creates a servercheck extension.

func (*Session) CreateServerServerCapability 

func (to *Session) CreateServerServerCapability(ssc tc.ServerServerCapability) (tc.Alerts, ReqInf, error)

CreateServerServerCapability assigns a Server Capability to a Server

func (*Session) CreateServerWithHdr 

func (to *Session) CreateServerWithHdr(server tc.ServerV30, hdr http.Header) (tc.Alerts, ReqInf, error)

CreateServerWithHdr creates the given server, with whatever headers are passed added to the request.

func (*Session) CreateServiceCategory 

func (to *Session) CreateServiceCategory(serviceCategory tc.ServiceCategory) (tc.Alerts, ReqInf, error)

CreateServiceCategory performs a post to create a service category.

func (*Session) CreateStaticDNSEntry 

func (to *Session) CreateStaticDNSEntry(sdns tc.StaticDNSEntry) (tc.Alerts, ReqInf, error)

CreateStaticDNSEntry creates a Static DNS Entry.

func (*Session) CreateStatusNullable 

func (to *Session) CreateStatusNullable(status tc.StatusNullable) (tc.Alerts, ReqInf, error)

CreateStatusNullable creates a new status, using the tc.StatusNullable structure.

func (*Session) CreateSteeringTarget 

func (to *Session) CreateSteeringTarget(st tc.SteeringTargetNullable) (tc.Alerts, ReqInf, error)

func (*Session) CreateSummaryStats 

func (to *Session) CreateSummaryStats(statsSummary tc.StatsSummary) (tc.Alerts, ReqInf, error)

CreateSummaryStats creates a stats summary

func (*Session) CreateTenant 

func (to *Session) CreateTenant(t *tc.Tenant) (*tc.TenantResponse, error)

CreateTenant creates the Tenant it's passed.

func (*Session) CreateTopology 

func (to *Session) CreateTopology(top tc.Topology) (*tc.TopologyResponse, ReqInf, error)

CreateTopology creates a topology and returns the response.

func (*Session) CreateType 

func (to *Session) CreateType(typ tc.Type) (tc.Alerts, ReqInf, error)

CreateType creates a Type. There should be a very good reason for doing this.

func (*Session) CreateUser 

func (to *Session) CreateUser(user *tc.User) (*tc.CreateUserResponse, ReqInf, error)

CreateUser creates a user

func (*Session) DeleteASNByASN 

func (to *Session) DeleteASNByASN(asn int) (tc.Alerts, ReqInf, error)

DeleteASNByASN deletes an ASN by asn number

func (*Session) DeleteCDNByID 

func (to *Session) DeleteCDNByID(id int) (tc.Alerts, ReqInf, error)

DeleteCDNByID deletes a CDN by ID.

func (*Session) DeleteCDNFederationByID 

func (to *Session) DeleteCDNFederationByID(CDNName string, ID int) (*tc.DeleteCDNFederationResponse, ReqInf, error)

func (*Session) DeleteCacheGroupByID 

func (to *Session) DeleteCacheGroupByID(id int) (tc.Alerts, ReqInf, error)

DELETE a CacheGroup by ID.

func (*Session) DeleteCacheGroupParameter 

func (to *Session) DeleteCacheGroupParameter(cacheGroupID, parameterID int) (tc.Alerts, ReqInf, error)

DeleteCacheGroupParameter Deassociates a Parameter with a Cache Group

func (*Session) DeleteCoordinateByID 

func (to *Session) DeleteCoordinateByID(id int) (tc.Alerts, ReqInf, error)

DELETE a Coordinate by ID

func (*Session) DeleteDeliveryService 

func (to *Session) DeleteDeliveryService(id string) (*tc.DeleteDeliveryServiceResponse, error)

DeleteDeliveryService deletes the DeliveryService matching the ID it's passed.

func (*Session) DeleteDeliveryServiceRequestByID 

func (to *Session) DeleteDeliveryServiceRequestByID(id int) (tc.Alerts, ReqInf, error)

DELETE a DeliveryServiceRequest by DeliveryServiceRequest assignee

func (*Session) DeleteDeliveryServiceRequestCommentByID 

func (to *Session) DeleteDeliveryServiceRequestCommentByID(id int) (tc.Alerts, ReqInf, error)

DELETE a delivery service request comment by ID

func (*Session) DeleteDeliveryServiceSSLKeysByID 

func (to *Session) DeleteDeliveryServiceSSLKeysByID(XMLID string) (string, ReqInf, error)

func (*Session) DeleteDeliveryServiceServer 

func (to *Session) DeleteDeliveryServiceServer(dsID int, serverID int) (tc.Alerts, ReqInf, error)

func (*Session) DeleteDeliveryServiceUser 

func (to *Session) DeleteDeliveryServiceUser(userID int, dsID int) (*tc.UserDeliveryServiceDeleteResponse, error)

DeleteDeliveryServiceUser deletes the association between the given delivery service and user

func (*Session) DeleteDeliveryServicesRequiredCapability 

func (to *Session) DeleteDeliveryServicesRequiredCapability(deliveryserviceID int, capability string) (tc.Alerts, ReqInf, error)

DeleteDeliveryServicesRequiredCapability unassigns a Required Capability from a Delivery Service

func (*Session) DeleteDivisionByID 

func (to *Session) DeleteDivisionByID(id int) (tc.Alerts, ReqInf, error)

DELETE a Division by Division id

func (*Session) DeleteFederationDeliveryService 

func (to *Session) DeleteFederationDeliveryService(federationID, deliveryServiceID int) (tc.Alerts, ReqInf, error)

DeleteFederationDeliveryService Deletes a given Delivery Service from a Federation

func (*Session) DeleteFederationResolver 

func (to *Session) DeleteFederationResolver(id uint) (tc.Alerts, ReqInf, error)

DeleteFederationResolver deletes the Federation Resolver identified by 'id'.

func (*Session) DeleteFederationResolverMappingsForCurrentUser 

func (to *Session) DeleteFederationResolverMappingsForCurrentUser() (tc.Alerts, ReqInf, error)

DeleteFederationResolverMappingsForCurrentUser removes ALL Federation Resolver mappings for ALL Federations assigned to the currently authenticated user, as well as deleting ALL of the Federation Resolvers themselves.

func (*Session) DeleteFederationUser 

func (to *Session) DeleteFederationUser(federationID, userID int) (tc.Alerts, ReqInf, error)

DeleteFederationUser Deletes a given User from a Federation

func (*Session) DeleteInvalidationJob 

func (to *Session) DeleteInvalidationJob(jobID uint64) (tc.Alerts, ReqInf, error)

Deletes a Content Invalidation Job

func (*Session) DeleteOriginByID 

func (to *Session) DeleteOriginByID(id int) (tc.Alerts, ReqInf, error)

DELETE an Origin by ID

func (*Session) DeleteParameterByID 

func (to *Session) DeleteParameterByID(id int) (tc.Alerts, ReqInf, error)

DeleteParameterByID DELETEs a Parameter by ID.

func (*Session) DeleteParameterByProfileParameter 

func (to *Session) DeleteParameterByProfileParameter(profile int, parameter int) (tc.Alerts, ReqInf, error)

DELETE a Parameter by Parameter

func (*Session) DeletePhysLocationByID 

func (to *Session) DeletePhysLocationByID(id int) (tc.Alerts, ReqInf, error)

DELETE a PhysLocation by ID

func (*Session) DeleteProfileByID 

func (to *Session) DeleteProfileByID(id int) (tc.Alerts, ReqInf, error)

DeleteProfileByID DELETEs a Profile by ID.

func (*Session) DeleteRegion 

func (to *Session) DeleteRegion(id *int, name *string) (tc.Alerts, ReqInf, error)

DeleteRegion lets you DELETE a Region. Only 1 parameter is required, not both.

func (*Session) DeleteRegionByID 

func (to *Session) DeleteRegionByID(id int) (tc.Alerts, ReqInf, error)

DeleteRegionByID DELETEs a Region by ID.

func (*Session) DeleteRoleByID 

func (to *Session) DeleteRoleByID(id int) (tc.Alerts, ReqInf, int, error)

DeleteRoleByID DELETEs a Role by ID.

func (*Session) DeleteServerByID 

func (to *Session) DeleteServerByID(id int) (tc.Alerts, ReqInf, error)

DeleteServerByID DELETEs a Server by ID.

func (*Session) DeleteServerCapability 

func (to *Session) DeleteServerCapability(name string) (tc.Alerts, ReqInf, error)

DeleteServerCapability deletes the given server capability by name.

func (*Session) DeleteServerCheckExtension 

func (to *Session) DeleteServerCheckExtension(id int) (tc.Alerts, ReqInf, error)

DeleteServerCheckExtension deletes a servercheck extension.

func (*Session) DeleteServerServerCapability 

func (to *Session) DeleteServerServerCapability(serverID int, serverCapability string) (tc.Alerts, ReqInf, error)

DeleteServerServerCapability unassigns a Server Capability from a Server

func (*Session) DeleteServiceCategoryByName 

func (to *Session) DeleteServiceCategoryByName(name string) (tc.Alerts, ReqInf, error)

DeleteServiceCategoryByName deletes a service category by the service category's unique name.

func (*Session) DeleteStaticDNSEntryByID 

func (to *Session) DeleteStaticDNSEntryByID(id int) (tc.Alerts, ReqInf, error)

DeleteStaticDNSEntryByID DELETEs a Static DNS Entry by ID.

func (*Session) DeleteStatusByID 

func (to *Session) DeleteStatusByID(id int) (tc.Alerts, ReqInf, error)

DeleteStatusByID DELETEs a Status by ID.

func (*Session) DeleteSteeringTarget 

func (to *Session) DeleteSteeringTarget(dsID int, targetID int) (tc.Alerts, ReqInf, error)

func (*Session) DeleteTenant 

func (to *Session) DeleteTenant(id string) (*tc.DeleteTenantResponse, error)

DeleteTenant deletes the Tenant matching the ID it's passed.

func (*Session) DeleteTopology 

func (to *Session) DeleteTopology(name string) (tc.Alerts, ReqInf, error)

DeleteTopology deletes the given topology by name.

func (*Session) DeleteTypeByID 

func (to *Session) DeleteTypeByID(id int) (tc.Alerts, ReqInf, error)

DeleteTypeByID DELETEs a Type by ID.

func (*Session) DeleteUserByID 

func (to *Session) DeleteUserByID(id int) (tc.Alerts, ReqInf, error)

DeleteUserByID updates user with the given id

func (*Session) ExportProfile 

func (to *Session) ExportProfile(id int) (*tc.ProfileExportResponse, ReqInf, error)

ExportProfile Returns an exported Profile.

func (*Session) Federations deprecated 

func (to *Session) Federations() ([]tc.AllDeliveryServiceFederationsMapping, ReqInf, error)

Deprecated: Federations will be removed in 6.0. Use FederationsWithHdr.

func (*Session) FederationsWithHdr 

func (to *Session) FederationsWithHdr(header http.Header) ([]tc.AllDeliveryServiceFederationsMapping, ReqInf, error)

func (*Session) GenerateSSLKeysForDS 

func (to *Session) GenerateSSLKeysForDS(XMLID string, CDNName string, sslFields tc.SSLKeyRequestFields) (string, ReqInf, error)

GenerateSSLKeysForDS generates ssl keys for a given cdn

func (*Session) GetAPICapabilities 

func (to *Session) GetAPICapabilities(capability string, order string) (tc.APICapabilityResponse, ReqInf, error)

GetAPICapabilities will retrieve API Capabilities. In the event that no capability parameter is supplied, it will return all existing. If a capability is supplied, it will return only those with an exact match. Order may be specified to change the default sort order.

func (*Session) GetASNsWithHeader 

func (to *Session) GetASNsWithHeader(params *url.Values, header http.Header) ([]tc.ASN, ReqInf, error)

GetASNsWithHeader Returns a list of ASNs matching query params

func (*Session) GetAbout 

func (to *Session) GetAbout() (map[string]string, ReqInf, error)

GetAbout gets data about the TO instance.

func (*Session) GetAccessibleDeliveryServicesByTenant deprecated 

func (to *Session) GetAccessibleDeliveryServicesByTenant(tenantId int) ([]tc.DeliveryServiceNullable, ReqInf, error)

GetAccessibleDeliveryServicesByTenant gets all delivery services associated with the given tenant and all of its children.

Warning: This method coerces its returned data into an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, GetDeliveryServicesV30WithHdr.

func (*Session) GetAllCacheGroupParameters 

func (to *Session) GetAllCacheGroupParameters() ([]tc.CacheGroupParametersResponseNullable, ReqInf, error)

GetAllCacheGroupParameters Gets all Cachegroup Parameter associations Deprecated: GetAllCacheGroupParameters will be removed in 6.0. Use GetAllCacheGroupParametersWithHdr.

func (*Session) GetAllCacheGroupParametersWithHdr 

func (to *Session) GetAllCacheGroupParametersWithHdr(header http.Header) ([]tc.CacheGroupParametersResponseNullable, ReqInf, error)

func (*Session) GetCDNByID 

func (to *Session) GetCDNByID(id int) ([]tc.CDN, ReqInf, error)

GetCDNByID a CDN by the CDN ID. Deprecated: GetCDNByID will be removed in 6.0. Use GetCDNByIDWithHdr.

func (*Session) GetCDNByIDWithHdr 

func (to *Session) GetCDNByIDWithHdr(id int, header http.Header) ([]tc.CDN, ReqInf, error)

func (*Session) GetCDNByName 

func (to *Session) GetCDNByName(name string) ([]tc.CDN, ReqInf, error)

GetCDNByName gets a CDN by the CDN name. Deprecated: GetCDNByName will be removed in 6.0. Use GetCDNByNameWithHdr.

func (*Session) GetCDNByNameWithHdr 

func (to *Session) GetCDNByNameWithHdr(name string, header http.Header) ([]tc.CDN, ReqInf, error)

func (*Session) GetCDNFederationsByID deprecated 

func (to *Session) GetCDNFederationsByID(CDNName string, ID int) (*tc.CDNFederationResponse, ReqInf, error)

Deprecated: GetCDNFederationsByID will be removed in 6.0. Use GetCDNFederationsByIDWithHdr.

func (*Session) GetCDNFederationsByIDWithHdr 

func (to *Session) GetCDNFederationsByIDWithHdr(CDNName string, ID int, header http.Header) (*tc.CDNFederationResponse, ReqInf, error)

func (*Session) GetCDNFederationsByName deprecated 

func (to *Session) GetCDNFederationsByName(CDNName string) (*tc.CDNFederationResponse, ReqInf, error)

Deprecated: GetCDNFederationsByName will be removed in 6.0. Use GetCDNFederationsByNameWithHdr.

func (*Session) GetCDNFederationsByNameWithHdr 

func (to *Session) GetCDNFederationsByNameWithHdr(CDNName string, header http.Header) (*tc.CDNFederationResponse, ReqInf, error)

func (*Session) GetCDNFederationsByNameWithHdrReturnList 

func (to *Session) GetCDNFederationsByNameWithHdrReturnList(CDNName string, header http.Header) ([]tc.CDNFederation, ReqInf, error)

func (*Session) GetCDNSSLKeys deprecated 

func (to *Session) GetCDNSSLKeys(name string) ([]tc.CDNSSLKeys, ReqInf, error)

Deprecated: GetCDNSSLKeys will be removed in 6.0. Use GetCDNSSLKeysWithHdr.

func (*Session) GetCDNSSLKeysWithHdr 

func (to *Session) GetCDNSSLKeysWithHdr(name string, header http.Header) ([]tc.CDNSSLKeys, ReqInf, error)

func (*Session) GetCDNs 

func (to *Session) GetCDNs() ([]tc.CDN, ReqInf, error)

GetCDNs eturns a list of CDNs. Deprecated: GetCDNs will be removed in 6.0. Use GetCDNsWithHdr.

func (*Session) GetCDNsWithHdr 

func (to *Session) GetCDNsWithHdr(header http.Header) ([]tc.CDN, ReqInf, error)

func (*Session) GetCRConfig 

func (to *Session) GetCRConfig(cdn string) ([]byte, ReqInf, error)

GetCRConfig returns the raw JSON bytes of the CRConfig from Traffic Ops, and whether the bytes were from the client's internal cache.

func (*Session) GetCRConfigNew 

func (to *Session) GetCRConfigNew(cdn string) ([]byte, ReqInf, error)

GetCRConfigNew returns the raw JSON bytes of the latest CRConfig from Traffic Ops, and whether the bytes were from the client's internal cache.

func (*Session) GetCacheGroupNullableByID 

func (to *Session) GetCacheGroupNullableByID(id int) ([]tc.CacheGroupNullable, ReqInf, error)

GET a CacheGroup by the CacheGroup ID. Deprecated: GetCacheGroupNullableByID will be removed in 6.0. Use GetCacheGroupNullableByIDWithHdr.

func (*Session) GetCacheGroupNullableByIDWithHdr 

func (to *Session) GetCacheGroupNullableByIDWithHdr(id int, header http.Header) ([]tc.CacheGroupNullable, ReqInf, error)

func (*Session) GetCacheGroupNullableByName 

func (to *Session) GetCacheGroupNullableByName(name string) ([]tc.CacheGroupNullable, ReqInf, error)

GET a CacheGroup by the CacheGroup name. Deprecated: GetCacheGroupNullableByName will be removed in 6.0. Use GetCacheGroupNullableByNameWithHdr.

func (*Session) GetCacheGroupNullableByNameWithHdr 

func (to *Session) GetCacheGroupNullableByNameWithHdr(name string, header http.Header) ([]tc.CacheGroupNullable, ReqInf, error)

func (*Session) GetCacheGroupNullableByShortName 

func (to *Session) GetCacheGroupNullableByShortName(shortName string) ([]tc.CacheGroupNullable, ReqInf, error)

GET a CacheGroup by the CacheGroup short name. Deprecated: GetCacheGroupNullableByShortName will be removed in 6.0. Use GetCacheGroupNullableByShortNameWithHdr.

func (*Session) GetCacheGroupNullableByShortNameWithHdr 

func (to *Session) GetCacheGroupNullableByShortNameWithHdr(shortName string, header http.Header) ([]tc.CacheGroupNullable, ReqInf, error)

func (*Session) GetCacheGroupParameters 

func (to *Session) GetCacheGroupParameters(cacheGroupID int) ([]tc.CacheGroupParameter, ReqInf, error)

GetCacheGroupParameters Gets a Cache Group's Parameters Deprecated: GetCacheGroupParameters will be removed in 6.0. Use GetCacheGroupParametersWithHdr.

func (*Session) GetCacheGroupParametersByQueryParams 

func (to *Session) GetCacheGroupParametersByQueryParams(cacheGroupID int, queryParams string) ([]tc.CacheGroupParameter, ReqInf, error)

GetCacheGroupParametersByQueryParams Gets a Cache Group's Parameters with query parameters Deprecated: GetCacheGroupParametersByQueryParams will be removed in 6.0. Use GetCacheGroupParametersByQueryParamsWithHdr.

func (*Session) GetCacheGroupParametersByQueryParamsWithHdr 

func (to *Session) GetCacheGroupParametersByQueryParamsWithHdr(cacheGroupID int, queryParams string, header http.Header) ([]tc.CacheGroupParameter, ReqInf, error)

func (*Session) GetCacheGroupParametersWithHdr 

func (to *Session) GetCacheGroupParametersWithHdr(cacheGroupID int, header http.Header) ([]tc.CacheGroupParameter, ReqInf, error)

func (*Session) GetCacheGroupsByQueryParams 

func (to *Session) GetCacheGroupsByQueryParams(qparams url.Values) ([]tc.CacheGroupNullable, ReqInf, error)

GetCacheGroupsByQueryParams gets cache groups by the given query parameters. Deprecated: GetCacheGroupsByQueryParams will be removed in 6.0. Use GetCacheGroupsByQueryParamsWithHdr.

func (*Session) GetCacheGroupsByQueryParamsWithHdr 

func (to *Session) GetCacheGroupsByQueryParamsWithHdr(qparams url.Values, header http.Header) ([]tc.CacheGroupNullable, ReqInf, error)

func (*Session) GetCacheGroupsNullable 

func (to *Session) GetCacheGroupsNullable() ([]tc.CacheGroupNullable, ReqInf, error)

Returns a list of CacheGroups. Deprecated: GetCacheGroupsNullable will be removed in 6.0. Use GetCacheGroupsNullableWithHdr.

func (*Session) GetCacheGroupsNullableWithHdr 

func (to *Session) GetCacheGroupsNullableWithHdr(header http.Header) ([]tc.CacheGroupNullable, ReqInf, error)

func (*Session) GetCapabilities 

func (to *Session) GetCapabilities() ([]tc.Capability, ReqInf, error)

GetCapabilities retrieves all capabilities. Deprecated: GetCapabilities will be removed in 6.0. Use GetCapabilitiesWithHdr.

func (*Session) GetCapabilitiesWithHdr 

func (to *Session) GetCapabilitiesWithHdr(header http.Header) ([]tc.Capability, ReqInf, error)

func (*Session) GetCapability 

func (to *Session) GetCapability(c string) (tc.Capability, ReqInf, error)

GetCapability retrieves only the capability named 'c'. Deprecated: GetCapability will be removed in 6.0. Use GetCapabilityWithHdr.

func (*Session) GetCapabilityWithHdr 

func (to *Session) GetCapabilityWithHdr(c string, header http.Header) (tc.Capability, ReqInf, error)

func (*Session) GetCoordinateByID 

func (to *Session) GetCoordinateByID(id int) ([]tc.Coordinate, ReqInf, error)

GET a Coordinate by the Coordinate id Deprecated: GetCoordinateByID will be removed in 6.0. Use GetCoordinateByIDWithHdr.

func (*Session) GetCoordinateByIDWithHdr 

func (to *Session) GetCoordinateByIDWithHdr(id int, header http.Header) ([]tc.Coordinate, ReqInf, error)

func (*Session) GetCoordinateByName 

func (to *Session) GetCoordinateByName(name string) ([]tc.Coordinate, ReqInf, error)

GET a Coordinate by the Coordinate name Deprecated: GetCoordinateByName will be removed in 6.0. Use GetCoordinateByNameWithHdr.

func (*Session) GetCoordinateByNameWithHdr 

func (to *Session) GetCoordinateByNameWithHdr(name string, header http.Header) ([]tc.Coordinate, ReqInf, error)

func (*Session) GetCoordinates 

func (to *Session) GetCoordinates() ([]tc.Coordinate, ReqInf, error)

Returns a list of Coordinates Deprecated: GetCoordinates will be removed in 6.0. Use GetCoordinatesWithHdr.

func (*Session) GetCoordinatesWithHdr 

func (to *Session) GetCoordinatesWithHdr(header http.Header) ([]tc.Coordinate, ReqInf, error)

func (*Session) GetCurrentStats 

func (to *Session) GetCurrentStats() (tc.TrafficStatsCDNStatsResponse, ReqInf, error)

GetCurrentStats gets current stats for each CDNs and a total across them

func (*Session) GetDeliveryServiceByXMLIDNullable deprecated 

func (to *Session) GetDeliveryServiceByXMLIDNullable(XMLID string) ([]tc.DeliveryServiceNullable, ReqInf, error)

GetDeliveryServiceByXMLIDNullable returns the Delivery Service identified by the passed XMLID. The length of the returned slice should always be 1 when the request is succesful - if it isn't something very wicked has happened to Traffic Ops.

Warning: This method coerces its returned data into an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, GetDeliveryServicesV30WithHdr.

func (*Session) GetDeliveryServiceByXMLIDNullableWithHdr 

func (to *Session) GetDeliveryServiceByXMLIDNullableWithHdr(XMLID string, header http.Header) ([]tc.DeliveryServiceNullableV30, ReqInf, error)

GetDeliveryServiceByXMLIDNullableWithHdr fetches all Delivery Services with the given XMLID.

func (*Session) GetDeliveryServiceCapacity 

func (to *Session) GetDeliveryServiceCapacity(id string) (*tc.DeliveryServiceCapacity, ReqInf, error)

GetDeliveryServiceCapacity gets the 'capacity' of the Delivery Service identified by the integral, unique identifier 'id' (which must be passed as a string). Deprecated: GetDeliveryServiceCapacity will be removed in 6.0. Use GetDeliveryServiceCapacityWithHdr.

func (*Session) GetDeliveryServiceCapacityWithHdr 

func (to *Session) GetDeliveryServiceCapacityWithHdr(id string, header http.Header) (*tc.DeliveryServiceCapacity, ReqInf, error)

func (*Session) GetDeliveryServiceHealth 

func (to *Session) GetDeliveryServiceHealth(id string) (*tc.DeliveryServiceHealth, ReqInf, error)

GetDeliveryServiceHealth gets the 'health' of the Delivery Service identified by the integral, unique identifier 'id' (which must be passed as a string). Deprecated: GetDeliveryServiceHealth will be removed in 6.0. Use GetDeliveryServiceHealthWithHdr.

func (*Session) GetDeliveryServiceHealthWithHdr 

func (to *Session) GetDeliveryServiceHealthWithHdr(id string, header http.Header) (*tc.DeliveryServiceHealth, ReqInf, error)

func (*Session) GetDeliveryServiceNullable deprecated 

func (to *Session) GetDeliveryServiceNullable(id string) (*tc.DeliveryServiceNullable, ReqInf, error)

GetDeliveryServiceNullable returns the Delivery Service identified by the integral, unique identifier 'id' (which must be passed as a string).

Warning: This method coerces its returned data into an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, GetDeliveryServicesV30WithHdr.

func (*Session) GetDeliveryServiceNullableWithHdr 

func (to *Session) GetDeliveryServiceNullableWithHdr(id string, header http.Header) (*tc.DeliveryServiceNullableV30, ReqInf, error)

GetDeliveryServiceNullableWithHdr fetches the Delivery Service with the given ID.

func (*Session) GetDeliveryServiceRegexes 

func (to *Session) GetDeliveryServiceRegexes() ([]tc.DeliveryServiceRegexes, ReqInf, error)

GetDeliveryServiceRegexes returns the "Regexes" (Regular Expressions) used by all (tenant-visible) Delivery Services. Deprecated: GetDeliveryServiceRegexes will be removed in 6.0. Use GetDeliveryServiceRegexesWithHdr.

func (*Session) GetDeliveryServiceRegexesByDSID 

func (to *Session) GetDeliveryServiceRegexesByDSID(dsID int, params map[string]string) ([]tc.DeliveryServiceIDRegex, ReqInf, error)

GetDeliveryServiceRegexesByDSID gets DeliveryServiceRegexes by a DS id also accepts an optional map of query parameters

func (*Session) GetDeliveryServiceRegexesWithHdr 

func (to *Session) GetDeliveryServiceRegexesWithHdr(header http.Header) ([]tc.DeliveryServiceRegexes, ReqInf, error)

func (*Session) GetDeliveryServiceRequestByID 

func (to *Session) GetDeliveryServiceRequestByID(id int) ([]tc.DeliveryServiceRequest, ReqInf, error)

GET a DeliveryServiceRequest by the DeliveryServiceRequest id Deprecated: GetDeliveryServiceRequestByID will be removed in 6.0. Use GetDeliveryServiceRequestByIDWithHdr.

func (*Session) GetDeliveryServiceRequestByIDWithHdr 

func (to *Session) GetDeliveryServiceRequestByIDWithHdr(id int, header http.Header) ([]tc.DeliveryServiceRequest, ReqInf, error)

func (*Session) GetDeliveryServiceRequestByXMLID 

func (to *Session) GetDeliveryServiceRequestByXMLID(XMLID string) ([]tc.DeliveryServiceRequest, ReqInf, error)

GET a DeliveryServiceRequest by the DeliveryServiceRequest XMLID Deprecated: GetDeliveryServiceRequestByXMLID will be removed in 6.0. Use GetDeliveryServiceRequestByXMLIDWithHdr.

func (*Session) GetDeliveryServiceRequestByXMLIDWithHdr 

func (to *Session) GetDeliveryServiceRequestByXMLIDWithHdr(XMLID string, header http.Header) ([]tc.DeliveryServiceRequest, ReqInf, error)

func (*Session) GetDeliveryServiceRequestCommentByID 

func (to *Session) GetDeliveryServiceRequestCommentByID(id int) ([]tc.DeliveryServiceRequestComment, ReqInf, error)

GET a delivery service request comment by ID Deprecated: GetDeliveryServiceRequestCommentByID will be removed in 6.0. Use GetDeliveryServiceRequestCommentByIDWithHdr.

func (*Session) GetDeliveryServiceRequestCommentByIDWithHdr 

func (to *Session) GetDeliveryServiceRequestCommentByIDWithHdr(id int, header http.Header) ([]tc.DeliveryServiceRequestComment, ReqInf, error)

func (*Session) GetDeliveryServiceRequestComments 

func (to *Session) GetDeliveryServiceRequestComments() ([]tc.DeliveryServiceRequestComment, ReqInf, error)

Returns a list of delivery service request comments Deprecated: GetDeliveryServiceRequestComments will be removed in 6.0. Use GetDeliveryServiceRequestCommentsWithHdr.

func (*Session) GetDeliveryServiceRequestCommentsWithHdr 

func (to *Session) GetDeliveryServiceRequestCommentsWithHdr(header http.Header) ([]tc.DeliveryServiceRequestComment, ReqInf, error)

func (*Session) GetDeliveryServiceRequests 

func (to *Session) GetDeliveryServiceRequests() ([]tc.DeliveryServiceRequest, ReqInf, error)

GetDeliveryServiceRequests retrieves all deliveryservices available to session user. Deprecated: GetDeliveryServiceRequests will be removed in 6.0. Use GetDeliveryServiceRequestsWithHdr.

func (*Session) GetDeliveryServiceRequestsWithHdr 

func (to *Session) GetDeliveryServiceRequestsWithHdr(header http.Header) ([]tc.DeliveryServiceRequest, ReqInf, error)

func (*Session) GetDeliveryServiceSSLKeysByID 

func (to *Session) GetDeliveryServiceSSLKeysByID(XMLID string) (*tc.DeliveryServiceSSLKeys, ReqInf, error)

GetDeliveryServiceSSLKeysByID returns information about the SSL Keys used by the Delivery Service identified by the passed XMLID. Deprecated: GetDeliveryServiceSSLKeysByID will be removed in 6.0. Use GetDeliveryServiceSSLKeysByIDWithHdr.

func (*Session) GetDeliveryServiceSSLKeysByIDWithHdr 

func (to *Session) GetDeliveryServiceSSLKeysByIDWithHdr(XMLID string, header http.Header) (*tc.DeliveryServiceSSLKeys, ReqInf, error)

func (*Session) GetDeliveryServiceServer 

func (to *Session) GetDeliveryServiceServer(page, limit string) ([]tc.DeliveryServiceServer, ReqInf, error)

GetDeliveryServiceServer returns associations between Delivery Services and servers using the provided pagination controls. Deprecated: GetDeliveryServiceServer will be removed in 6.0. Use GetDeliveryServiceServerWithHdr.

func (*Session) GetDeliveryServiceServerWithHdr 

func (to *Session) GetDeliveryServiceServerWithHdr(page, limit string, header http.Header) ([]tc.DeliveryServiceServer, ReqInf, error)

func (*Session) GetDeliveryServiceServers 

func (to *Session) GetDeliveryServiceServers() (tc.DeliveryServiceServerResponse, ReqInf, error)

GetDeliveryServiceServers gets all delivery service servers, with the default API limit. Deprecated: GetDeliveryServiceServers will be removed in 6.0. Use GetDeliveryServiceServersWithHdr.

func (*Session) GetDeliveryServiceServersN 

func (to *Session) GetDeliveryServiceServersN(n int) (tc.DeliveryServiceServerResponse, ReqInf, error)

GetDeliveryServiceServersN gets all delivery service servers, with a limit of n. Deprecated: GetDeliveryServiceServersN will be removed in 6.0. Use GetDeliveryServiceServersNWithHdr.

func (*Session) GetDeliveryServiceServersNWithHdr 

func (to *Session) GetDeliveryServiceServersNWithHdr(n int, header http.Header) (tc.DeliveryServiceServerResponse, ReqInf, error)

func (*Session) GetDeliveryServiceServersWithHdr 

func (to *Session) GetDeliveryServiceServersWithHdr(h http.Header) (tc.DeliveryServiceServerResponse, ReqInf, error)

func (*Session) GetDeliveryServiceServersWithLimits 

func (to *Session) GetDeliveryServiceServersWithLimits(limit int, deliveryServiceIDs []int, serverIDs []int) (tc.DeliveryServiceServerResponse, ReqInf, error)

GetDeliveryServiceServersWithLimits gets all delivery service servers, allowing specifying the limit of mappings to return, the delivery services to return, and the servers to return. The limit may be 0, in which case the default limit will be applied. The deliveryServiceIDs and serverIDs may be nil or empty, in which case all delivery services and/or servers will be returned. Deprecated: GetDeliveryServiceServersWithLimits will be removed in 6.0. Use GetDeliveryServiceServersWithLimitsWithHdr.

func (*Session) GetDeliveryServiceServersWithLimitsWithHdr 

func (to *Session) GetDeliveryServiceServersWithLimitsWithHdr(limit int, deliveryServiceIDs []int, serverIDs []int, header http.Header) (tc.DeliveryServiceServerResponse, ReqInf, error)

func (*Session) GetDeliveryServiceURISigningKeys deprecated 

func (to *Session) GetDeliveryServiceURISigningKeys(dsName string) ([]byte, ReqInf, error)

Deprecated: GetDeliveryServiceURISigningKeys will be removed in 6.0. Use GetDeliveryServiceURISigningKeysWithHdr.

func (*Session) GetDeliveryServiceURISigningKeysWithHdr 

func (to *Session) GetDeliveryServiceURISigningKeysWithHdr(dsName string, header http.Header) ([]byte, ReqInf, error)

GetDeliveryServiceURISigningKeys returns the URI-signing keys used by the Delivery Service identified by the XMLID 'dsName'. The result is not parsed.

func (*Session) GetDeliveryServiceURLSigKeys 

func (to *Session) GetDeliveryServiceURLSigKeys(dsName string) (tc.URLSigKeys, ReqInf, error)

GetDeliveryServiceURLSigKeys returns the URL-signing keys used by the Delivery Service identified by the XMLID 'dsName'. Deprecated: GetDeliveryServiceURLSigKeys will be removed in 6.0. Use GetDeliveryServiceURLSigKeysWithHdr.

func (*Session) GetDeliveryServiceURLSigKeysWithHdr 

func (to *Session) GetDeliveryServiceURLSigKeysWithHdr(dsName string, header http.Header) (tc.URLSigKeys, ReqInf, error)

func (*Session) GetDeliveryServicesByCDNID deprecated 

func (to *Session) GetDeliveryServicesByCDNID(cdnID int) ([]tc.DeliveryServiceNullable, ReqInf, error)

GetDeliveryServicesByCDNID returns the (tenant-visible) Delivery Services within the CDN identified by the integral, unique identifier 'cdnID'.

Warning: This method coerces its returned data into an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, GetDeliveryServicesV30WithHdr.

func (*Session) GetDeliveryServicesByCDNIDWithHdr 

func (to *Session) GetDeliveryServicesByCDNIDWithHdr(cdnID int, header http.Header) ([]tc.DeliveryServiceNullable, ReqInf, error)

func (*Session) GetDeliveryServicesByServer deprecated 

func (to *Session) GetDeliveryServicesByServer(id int) ([]tc.DeliveryServiceNullable, ReqInf, error)

GetDeliveryServicesByServer returns all of the (tenant-visible) Delivery Services assigned to the server identified by the integral, unique identifier 'id'.

Warning: This method coerces its returned data into an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, GetDeliveryServicesByServerV30WithHdr.

func (*Session) GetDeliveryServicesByServerV30WithHdr 

func (to *Session) GetDeliveryServicesByServerV30WithHdr(id int, header http.Header) ([]tc.DeliveryServiceNullableV30, ReqInf, error)

func (*Session) GetDeliveryServicesByServerWithHdr 

func (to *Session) GetDeliveryServicesByServerWithHdr(id int, header http.Header) ([]tc.DeliveryServiceNullable, ReqInf, error)

func (*Session) GetDeliveryServicesEligible 

func (to *Session) GetDeliveryServicesEligible(dsID int) ([]tc.DSServer, ReqInf, error)

GetDeliveryServicesEligible returns the servers eligible for assignment to the Delivery Service identified by the integral, unique identifier 'dsID'. Deprecated: GetDeliveryServicesEligible will be removed in 6.0. Use GetDeliveryServicesEligibleWithHdr.

func (*Session) GetDeliveryServicesEligibleWithHdr 

func (to *Session) GetDeliveryServicesEligibleWithHdr(dsID int, header http.Header) ([]tc.DSServer, ReqInf, error)

func (*Session) GetDeliveryServicesNullable deprecated 

func (to *Session) GetDeliveryServicesNullable() ([]tc.DeliveryServiceNullable, ReqInf, error)

GetDeliveryServicesNullable returns a slice of Delivery Services.

Warning: This method coerces its returned data into an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, GetDeliveryServicesV30WithHdr.

func (*Session) GetDeliveryServicesNullableWithHdr 

func (to *Session) GetDeliveryServicesNullableWithHdr(header http.Header) ([]tc.DeliveryServiceNullable, ReqInf, error)

func (*Session) GetDeliveryServicesRequiredCapabilities 

func (to *Session) GetDeliveryServicesRequiredCapabilities(deliveryServiceID *int, xmlID, capability *string) ([]tc.DeliveryServicesRequiredCapability, ReqInf, error)

GetDeliveryServicesRequiredCapabilities retrieves a list of Required Capabilities that are assigned to a Delivery Service Callers can filter the results by delivery service id, xml id and/or required capability via the optional parameters Deprecated: GetDeliveryServicesRequiredCapabilities will be removed in 6.0. Use GetDeliveryServicesRequiredCapabilitiesWithHdr.

func (*Session) GetDeliveryServicesRequiredCapabilitiesWithHdr 

func (to *Session) GetDeliveryServicesRequiredCapabilitiesWithHdr(deliveryServiceID *int, xmlID, capability *string, header http.Header) ([]tc.DeliveryServicesRequiredCapability, ReqInf, error)

func (*Session) GetDeliveryServicesV30WithHdr 

func (to *Session) GetDeliveryServicesV30WithHdr(header http.Header, params url.Values) ([]tc.DeliveryServiceNullableV30, ReqInf, error)

GetDeliveryServicesV30WithHdr returns all (tenant-visible) Delivery Services that satisfy the passed query string parameters. See the API documentation for information on the available parameters.

func (*Session) GetDivisionByID 

func (to *Session) GetDivisionByID(id int) ([]tc.Division, ReqInf, error)

GET a Division by the Division id Deprecated: GetDivisionByID will be removed in 6.0. Use GetDivisionByIDWithHdr.

func (*Session) GetDivisionByIDWithHdr 

func (to *Session) GetDivisionByIDWithHdr(id int, header http.Header) ([]tc.Division, ReqInf, error)

func (*Session) GetDivisionByName 

func (to *Session) GetDivisionByName(name string) ([]tc.Division, ReqInf, error)

GET a Division by the Division name Deprecated: GetDivisionByName will be removed in 6.0. Use GetDivisionByNameWithHdr.

func (*Session) GetDivisionByNameWithHdr 

func (to *Session) GetDivisionByNameWithHdr(name string, header http.Header) ([]tc.Division, ReqInf, error)

func (*Session) GetDivisions 

func (to *Session) GetDivisions() ([]tc.Division, ReqInf, error)

Returns a list of Divisions Deprecated: GetDivisions will be removed in 6.0. Use GetDivisionsWithHdr.

func (*Session) GetDivisionsWithHdr 

func (to *Session) GetDivisionsWithHdr(header http.Header) ([]tc.Division, ReqInf, error)

func (*Session) GetDomains deprecated 

func (to *Session) GetDomains() ([]tc.Domain, ReqInf, error)

Deprecated: GetDomains will be removed in 6.0. Use GetDomainsWithHdr.

func (*Session) GetDomainsWithHdr 

func (to *Session) GetDomainsWithHdr(header http.Header) ([]tc.Domain, ReqInf, error)

func (*Session) GetFederationDeliveryServices 

func (to *Session) GetFederationDeliveryServices(federationID int) ([]tc.FederationDeliveryServiceNullable, ReqInf, error)

GetFederationDeliveryServices Returns a given Federation's Delivery Services Deprecated: GetFederationDeliveryServices will be removed in 6.0. Use GetFederationDeliveryServicesWithHdr.

func (*Session) GetFederationDeliveryServicesWithHdr 

func (to *Session) GetFederationDeliveryServicesWithHdr(federationID int, header http.Header) ([]tc.FederationDeliveryServiceNullable, ReqInf, error)

func (*Session) GetFederationFederationResolversByID 

func (to *Session) GetFederationFederationResolversByID(id int) (tc.FederationFederationResolversResponse, ReqInf, error)

GetFederationFederationResolversByID retrieves all Federation Resolvers belonging to Federation of ID.

func (*Session) GetFederationResolverByID 

func (to *Session) GetFederationResolverByID(ID uint) (tc.FederationResolver, ReqInf, error)

GetFederationResolverByID retrieves a single Federation Resolver identified by ID. Deprecated: GetFederationResolverByID will be removed in 6.0. Use GetFederationResolverByIDWithHdr.

func (*Session) GetFederationResolverByIDWithHdr 

func (to *Session) GetFederationResolverByIDWithHdr(ID uint, header http.Header) (tc.FederationResolver, ReqInf, error)

func (*Session) GetFederationResolverByIPAddress 

func (to *Session) GetFederationResolverByIPAddress(ip string) (tc.FederationResolver, ReqInf, error)

GetFederationResolverByIPAddress retrieves the Federation Resolver that uses the IP address or CIDR-notation subnet 'ip'. Deprecated: GetFederationResolverByIPAddress will be removed in 6.0. Use GetFederationResolverByIPAddressWithHdr.

func (*Session) GetFederationResolverByIPAddressWithHdr 

func (to *Session) GetFederationResolverByIPAddressWithHdr(ip string, header http.Header) (tc.FederationResolver, ReqInf, error)

func (*Session) GetFederationResolvers 

func (to *Session) GetFederationResolvers() ([]tc.FederationResolver, ReqInf, error)

GetFederationResolvers retrieves all Federation Resolvers from Traffic Ops Deprecated: GetFederationResolvers will be removed in 6.0. Use GetFederationResolversWithHdr.

func (*Session) GetFederationResolversByType 

func (to *Session) GetFederationResolversByType(t string) ([]tc.FederationResolver, ReqInf, error)

GetFederationResolversByType gets all Federation Resolvers that are of the Type named 't'. Deprecated: GetFederationResolversByType will be removed in 6.0. Use GetFederationResolversByTypeWithHdr.

func (*Session) GetFederationResolversByTypeWithHdr 

func (to *Session) GetFederationResolversByTypeWithHdr(t string, header http.Header) ([]tc.FederationResolver, ReqInf, error)

func (*Session) GetFederationResolversWithHdr 

func (to *Session) GetFederationResolversWithHdr(header http.Header) ([]tc.FederationResolver, ReqInf, error)

func (*Session) GetFederationUsers 

func (to *Session) GetFederationUsers(federationID int) ([]tc.FederationUser, ReqInf, error)

GetFederationUsers Returns a given Federation's Users Deprecated: GetFederationUsers will be removed in 6.0. Use GetFederationUsersWithHdr.

func (*Session) GetFederationUsersWithHdr 

func (to *Session) GetFederationUsersWithHdr(federationID int, header http.Header) ([]tc.FederationUser, ReqInf, error)

func (*Session) GetFirstServer 

func (to *Session) GetFirstServer(params *url.Values, header http.Header) (tc.ServerV30, ReqInf, error)

GetFirstServer returns the first server in a servers GET response. If no servers match, an error is returned. The 'params' parameter can be used to optionally pass URL "query string parameters" in the request. It returns, in order, the API response that Traffic Ops returned, a request info object, and any error that occurred.

func (*Session) GetInvalidationJobs 

func (to *Session) GetInvalidationJobs(ds *interface{}, user *interface{}) ([]tc.InvalidationJob, ReqInf, error)

Returns a list of Content Invalidation Jobs visible to your Tenant, filtered according to ds and user

Either or both of ds and user may be nil, but when they are not they cause filtering of the returned jobs by Delivery Service and Traffic Ops user, respectively.

ds may be a uint, int, or float64 indicating the integral, unique identifier of the desired Delivery Service (in the case of a float64 the fractional part is dropped, e.g. 3.45 -> 3), or it may be a string, in which case it should be the xml_id of the desired Delivery Service, or it may be an actual tc.DeliveryService or tc.DeliveryServiceNullable structure.

Likewise, user may be a uint, int or float64 indicating the integral, unique identifier of the desired user (in the case of a float64 the fractional part is dropped, e.g. 3.45 -> 3), or it may be a string, in which case it should be the username of the desired user, or it may be an actual tc.User or tc.UserCurrent structure.

func (*Session) GetJobs 

func (to *Session) GetJobs(deliveryServiceID *int, userID *int) ([]tc.Job, ReqInf, error)

GetJobs returns a list of Jobs. If deliveryServiceID or userID are not nil, only jobs for that delivery service or belonging to that user are returned. Both deliveryServiceID and userID may be nil.

Deprecated, use GetInvalidationJobs instead

func (*Session) GetLogs 

func (to *Session) GetLogs() ([]tc.Log, ReqInf, error)

GetLogs gets a list of logs.

func (*Session) GetLogsByDays 

func (to *Session) GetLogsByDays(days int) ([]tc.Log, ReqInf, error)

GetLogsByDays gets a list of logs limited to a certain number of days.

func (*Session) GetLogsByLimit 

func (to *Session) GetLogsByLimit(limit int) ([]tc.Log, ReqInf, error)

GetLogsByLimit gets a list of logs limited to a certain number of logs.

func (*Session) GetLogsByQueryParams 

func (to *Session) GetLogsByQueryParams(queryParams string) ([]tc.Log, ReqInf, error)

GetLogsByQueryParams gets a list of logs filtered by query params.

func (*Session) GetOSVersions 

func (to *Session) GetOSVersions() (map[string]string, ReqInf, error)

GetOSVersions GETs all available Operating System (OS) versions for ISO generation, as well as the name of the directory where the "kickstarter" files are found. Structure of returned map: 

key:   Name of OS
value: Directory where the ISO source can be found

func (*Session) GetOriginByID 

func (to *Session) GetOriginByID(id int) ([]tc.Origin, ReqInf, error)

GET an Origin by the Origin ID

func (*Session) GetOriginByName 

func (to *Session) GetOriginByName(name string) ([]tc.Origin, ReqInf, error)

GET an Origin by the Origin name

func (*Session) GetOrigins 

func (to *Session) GetOrigins() ([]tc.Origin, ReqInf, error)

Returns a list of Origins

func (*Session) GetOriginsByDeliveryServiceID 

func (to *Session) GetOriginsByDeliveryServiceID(id int) ([]tc.Origin, ReqInf, error)

GET a list of Origins by Delivery Service ID

func (*Session) GetOriginsByQueryParams 

func (to *Session) GetOriginsByQueryParams(queryParams string) ([]tc.Origin, ReqInf, error)

GET a list of Origins by a query parameter string

func (*Session) GetParameterByConfigFile 

func (to *Session) GetParameterByConfigFile(configFile string) ([]tc.Parameter, ReqInf, error)

GetParameterByConfigFile GETs a Parameter by the Parameter ConfigFile. Deprecated: GetParameterByConfigFile will be removed in 6.0. Use GetParameterByConfigFileWithHdr.

func (*Session) GetParameterByConfigFileWithHdr 

func (to *Session) GetParameterByConfigFileWithHdr(configFile string, header http.Header) ([]tc.Parameter, ReqInf, error)

func (*Session) GetParameterByID 

func (to *Session) GetParameterByID(id int) ([]tc.Parameter, ReqInf, error)

GetParameterByID GETs a Parameter by the Parameter ID. Deprecated: GetParameterByID will be removed in 6.0. Use GetParameterByIDWithHdr.

func (*Session) GetParameterByIDWithHdr 

func (to *Session) GetParameterByIDWithHdr(id int, header http.Header) ([]tc.Parameter, ReqInf, error)

func (*Session) GetParameterByName 

func (to *Session) GetParameterByName(name string) ([]tc.Parameter, ReqInf, error)

GetParameterByName GETs a Parameter by the Parameter name. Deprecated: GetParameterByName will be removed in 6.0. Use GetParameterByNameWithHdr.

func (*Session) GetParameterByNameAndConfigFile 

func (to *Session) GetParameterByNameAndConfigFile(name string, configFile string) ([]tc.Parameter, ReqInf, error)

GetParameterByNameAndConfigFile GETs a Parameter by the Parameter Name and ConfigFile. Deprecated: GetParameterByNameAndConfigFile will be removed in 6.0. Use GetParameterByNameAndConfigFileWithHdr.

func (*Session) GetParameterByNameAndConfigFileAndValue 

func (to *Session) GetParameterByNameAndConfigFileAndValue(name, configFile, value string) ([]tc.Parameter, ReqInf, error)

GetParameterByNameAndConfigFileAndValue GETs a Parameter by the Parameter Name and ConfigFile and Value. TODO: API should support all 3, but does not support filter by value currently. Until then, loop through hits until you find one with that value. Deprecated: GetParameterByNameAndConfigFileAndValue will be removed in 6.0. Use GetParameterByNameAndConfigFileAndValueWithHdr.

func (*Session) GetParameterByNameAndConfigFileAndValueWithHdr 

func (to *Session) GetParameterByNameAndConfigFileAndValueWithHdr(name, configFile, value string, header http.Header) ([]tc.Parameter, ReqInf, error)

func (*Session) GetParameterByNameAndConfigFileWithHdr 

func (to *Session) GetParameterByNameAndConfigFileWithHdr(name string, configFile string, header http.Header) ([]tc.Parameter, ReqInf, error)

func (*Session) GetParameterByNameWithHdr 

func (to *Session) GetParameterByNameWithHdr(name string, header http.Header) ([]tc.Parameter, ReqInf, error)

func (*Session) GetParameters 

func (to *Session) GetParameters() ([]tc.Parameter, ReqInf, error)

GetParameters returns a list of Parameters. Deprecated: GetParameters will be removed in 6.0. Use GetParametersWithHdr.

func (*Session) GetParametersByProfileName 

func (to *Session) GetParametersByProfileName(profileName string) ([]tc.Parameter, ReqInf, error)

GetParametersByProfileName gets all of the Parameters assigned to the Profile named 'profileName'. Deprecated: GetParametersByProfileName will be removed in 6.0. Use GetParametersByProfileNameWithHdr.

func (*Session) GetParametersByProfileNameWithHdr 

func (to *Session) GetParametersByProfileNameWithHdr(profileName string, header http.Header) ([]tc.Parameter, ReqInf, error)

func (*Session) GetParametersWithHdr 

func (to *Session) GetParametersWithHdr(header http.Header) ([]tc.Parameter, ReqInf, error)

func (*Session) GetPhysLocationByID 

func (to *Session) GetPhysLocationByID(id int) ([]tc.PhysLocation, ReqInf, error)

GET a PhysLocation by the PhysLocation ID Deprecated: GetPhysLocationByID will be removed in 6.0. Use GetPhysLocationByIDWithHdr.

func (*Session) GetPhysLocationByIDWithHdr 

func (to *Session) GetPhysLocationByIDWithHdr(id int, header http.Header) ([]tc.PhysLocation, ReqInf, error)

func (*Session) GetPhysLocationByName 

func (to *Session) GetPhysLocationByName(name string) ([]tc.PhysLocation, ReqInf, error)

GET a PhysLocation by the PhysLocation name Deprecated: GetPhysLocationByName will be removed in 6.0. Use GetPhysLocationByNameWithHdr.

func (*Session) GetPhysLocationByNameWithHdr 

func (to *Session) GetPhysLocationByNameWithHdr(name string, header http.Header) ([]tc.PhysLocation, ReqInf, error)

func (*Session) GetPhysLocations 

func (to *Session) GetPhysLocations(params map[string]string) ([]tc.PhysLocation, ReqInf, error)

Returns a list of PhysLocations with optional query parameters applied Deprecated: GetPhysLocations will be removed in 6.0. Use GetPhysLocationsWithHdr.

func (*Session) GetPhysLocationsWithHdr 

func (to *Session) GetPhysLocationsWithHdr(params map[string]string, header http.Header) ([]tc.PhysLocation, ReqInf, error)

func (*Session) GetProfileByCDNID 

func (to *Session) GetProfileByCDNID(cdnID int) ([]tc.Profile, ReqInf, error)

GetProfileByCDNID GETs a Profile by the Profile CDN ID. Deprecated: GetProfileByCDNID will be removed in 6.0. Use GetProfileByCDNIDWithHdr.

func (*Session) GetProfileByCDNIDWithHdr 

func (to *Session) GetProfileByCDNIDWithHdr(cdnID int, header http.Header) ([]tc.Profile, ReqInf, error)

func (*Session) GetProfileByID 

func (to *Session) GetProfileByID(id int) ([]tc.Profile, ReqInf, error)

GetProfileByID GETs a Profile by the Profile ID. Deprecated: GetProfileByID will be removed in 6.0. Use GetProfileByIDWithHdr.

func (*Session) GetProfileByIDWithHdr 

func (to *Session) GetProfileByIDWithHdr(id int, header http.Header) ([]tc.Profile, ReqInf, error)

func (*Session) GetProfileByName 

func (to *Session) GetProfileByName(name string) ([]tc.Profile, ReqInf, error)

GetProfileByName GETs a Profile by the Profile name. Deprecated: GetProfileByName will be removed in 6.0. Use GetProfileByNameWithHdr.

func (*Session) GetProfileByNameWithHdr 

func (to *Session) GetProfileByNameWithHdr(name string, header http.Header) ([]tc.Profile, ReqInf, error)

func (*Session) GetProfileByParameter 

func (to *Session) GetProfileByParameter(param string) ([]tc.Profile, ReqInf, error)

GetProfileByParameter GETs a Profile by the Profile "param". Deprecated: GetProfileByParameter will be removed in 6.0. Use GetProfileByParameterWithHdr.

func (*Session) GetProfileByParameterWithHdr 

func (to *Session) GetProfileByParameterWithHdr(param string, header http.Header) ([]tc.Profile, ReqInf, error)

func (*Session) GetProfileParameterByQueryParams 

func (to *Session) GetProfileParameterByQueryParams(queryParams string) ([]tc.ProfileParameter, ReqInf, error)

GET a Profile Parameter by the Parameter Deprecated: GetProfileParameterByQueryParams will be removed in 6.0. Use GetProfileParameterByQueryParamsWithHdr.

func (*Session) GetProfileParameterByQueryParamsWithHdr 

func (to *Session) GetProfileParameterByQueryParamsWithHdr(queryParams string, header http.Header) ([]tc.ProfileParameter, ReqInf, error)

func (*Session) GetProfileParameters 

func (to *Session) GetProfileParameters() ([]tc.ProfileParameter, ReqInf, error)

Returns a list of Profile Parameters Deprecated: GetProfileParameters will be removed in 6.0. Use GetProfileParametersWithHdr.

func (*Session) GetProfileParametersWithHdr 

func (to *Session) GetProfileParametersWithHdr(header http.Header) ([]tc.ProfileParameter, ReqInf, error)

func (*Session) GetProfiles 

func (to *Session) GetProfiles() ([]tc.Profile, ReqInf, error)

GetProfiles returns a list of Profiles. Deprecated: GetProfiles will be removed in 6.0. Use GetProfilesWithHdr.

func (*Session) GetProfilesWithHdr 

func (to *Session) GetProfilesWithHdr(header http.Header) ([]tc.Profile, ReqInf, error)

func (*Session) GetRegionByID 

func (to *Session) GetRegionByID(id int) ([]tc.Region, ReqInf, error)

GetRegionByID GETs a Region by the Region ID. Deprecated: GetRegionByID will be removed in 6.0. Use GetRegionByIDWithHdr.

func (*Session) GetRegionByIDWithHdr 

func (to *Session) GetRegionByIDWithHdr(id int, header http.Header) ([]tc.Region, ReqInf, error)

func (*Session) GetRegionByName 

func (to *Session) GetRegionByName(name string) ([]tc.Region, ReqInf, error)

GetRegionByName GETs a Region by the Region name. Deprecated: GetRegionByName will be removed in 6.0. Use GetRegionByNameHdr.

func (*Session) GetRegionByNameWithHdr 

func (to *Session) GetRegionByNameWithHdr(name string, header http.Header) ([]tc.Region, ReqInf, error)

func (*Session) GetRegions 

func (to *Session) GetRegions() ([]tc.Region, ReqInf, error)

GetRegions returns a list of regions. Deprecated: GetRegions will be removed in 6.0. Use GetRegionsWithHdr.

func (*Session) GetRegionsWithHdr 

func (to *Session) GetRegionsWithHdr(header http.Header) ([]tc.Region, ReqInf, error)

func (*Session) GetRoleByID 

func (to *Session) GetRoleByID(id int) ([]tc.Role, ReqInf, int, error)

GetRoleByID GETs a Role by the Role ID. Deprecated: GetRoleByID will be removed in 6.0. Use GetRoleByIDWithHdr.

func (*Session) GetRoleByIDWithHdr 

func (to *Session) GetRoleByIDWithHdr(id int, header http.Header) ([]tc.Role, ReqInf, int, error)

func (*Session) GetRoleByName 

func (to *Session) GetRoleByName(name string) ([]tc.Role, ReqInf, int, error)

GetRoleByName GETs a Role by the Role name. Deprecated: GetRoleByName will be removed in 6.0. Use GetRoleByNameWithHdr.

func (*Session) GetRoleByNameWithHdr 

func (to *Session) GetRoleByNameWithHdr(name string, header http.Header) ([]tc.Role, ReqInf, int, error)

func (*Session) GetRoleByQueryParams 

func (to *Session) GetRoleByQueryParams(queryParams map[string]string) ([]tc.Role, ReqInf, int, error)

GetRoleByQueryParams gets a Role by the Role query parameters. Deprecated: GetRoleByQueryParams will be removed in 6.0. Use GetRoleByQueryParamsWithHdr.

func (*Session) GetRoleByQueryParamsWithHdr 

func (to *Session) GetRoleByQueryParamsWithHdr(queryParams map[string]string, header http.Header) ([]tc.Role, ReqInf, int, error)

func (*Session) GetRoles 

func (to *Session) GetRoles() ([]tc.Role, ReqInf, int, error)

GetRoles returns a list of roles. Deprecated: GetRoles will be removed in 6.0. Use GetRolesWithHdr.

func (*Session) GetRolesWithHdr 

func (to *Session) GetRolesWithHdr(header http.Header) ([]tc.Role, ReqInf, int, error)

func (*Session) GetServerCapabilities 

func (to *Session) GetServerCapabilities() ([]tc.ServerCapability, ReqInf, error)

GetServerCapabilities returns all the server capabilities. Deprecated: GetServerCapabilities will be removed in 6.0. Use GetServerCapabilitiesWithHdr.

func (*Session) GetServerCapabilitiesWithHdr 

func (to *Session) GetServerCapabilitiesWithHdr(header http.Header) ([]tc.ServerCapability, ReqInf, error)

func (*Session) GetServerCapability 

func (to *Session) GetServerCapability(name string) (*tc.ServerCapability, ReqInf, error)

GetServerCapability returns the given server capability by name. Deprecated: GetServerCapability will be removed in 6.0. Use GetServerCapabilityWithHdr.

func (*Session) GetServerCapabilityWithHdr 

func (to *Session) GetServerCapabilityWithHdr(name string, header http.Header) (*tc.ServerCapability, ReqInf, error)

func (*Session) GetServerCheckExtensions 

func (to *Session) GetServerCheckExtensions() (tc.ServerCheckExtensionResponse, ReqInf, error)

GetServerCheckExtensions gets all servercheck extensions.

func (*Session) GetServerDetailsByHostName 

func (to *Session) GetServerDetailsByHostName(hostName string) ([]tc.ServerDetailV30, ReqInf, error)

GetServerDetailsByHostName GETs Servers by the Server hostname. Deprecated: GetServerDetailsByHostName will be removed in 6.0. Use GetServerDetailsByHostNameWithHdr.

func (*Session) GetServerDetailsByHostNameWithHdr 

func (to *Session) GetServerDetailsByHostNameWithHdr(hostName string, header http.Header) ([]tc.ServerDetailV30, ReqInf, error)

func (*Session) GetServerFQDN 

func (to *Session) GetServerFQDN(n string) (string, tc.Alerts, ReqInf, error)

GetServerFQDN returns the Fully Qualified Domain Name (FQDN) of the first server found to have the Host Name 'n'. Deprecated: GetServerFQDN will be removed in 6.0. Use GetServerFQDNWithHdr.

func (*Session) GetServerFQDNWithHdr 

func (to *Session) GetServerFQDNWithHdr(n string, header http.Header) (string, tc.Alerts, ReqInf, error)

func (*Session) GetServerIDDeliveryServices 

func (to *Session) GetServerIDDeliveryServices(server int) ([]tc.DeliveryServiceNullable, ReqInf, error)

GetServerIDDeliveryServices returns all of the Delivery Services assigned to the server identified by the integral, unique identifier 'server'. Deprecated: GetServerIDDeliveryServices will be removed in 6.0. Use GetServerIDDeliveryServicesWithHdr.

func (*Session) GetServerIDDeliveryServicesWithHdr 

func (to *Session) GetServerIDDeliveryServicesWithHdr(server int, header http.Header) ([]tc.DeliveryServiceNullable, ReqInf, error)

func (*Session) GetServerServerCapabilities 

func (to *Session) GetServerServerCapabilities(serverID *int, serverHostName, serverCapability *string) ([]tc.ServerServerCapability, ReqInf, error)

GetServerServerCapabilities retrieves a list of Server Capabilities that are assigned to a Server Callers can filter the results by server id, server host name and/or server capability via the optional parameters Deprecated: GetServerServerCapabilities will be removed in 6.0. Use GetServerServerCapabilitiesWithHdr.

func (*Session) GetServerServerCapabilitiesWithHdr 

func (to *Session) GetServerServerCapabilitiesWithHdr(serverID *int, serverHostName, serverCapability *string, header http.Header) ([]tc.ServerServerCapability, ReqInf, error)

func (*Session) GetServerUpdateStatus 

func (to *Session) GetServerUpdateStatus(hostName string) (tc.ServerUpdateStatus, ReqInf, error)

GetServerUpdateStatus GETs the Server Update Status by the Server hostname. Deprecated: GetServerUpdateStatus will be removed in 6.0. Use GetServerUpdateStatusWithHdr.

func (*Session) GetServerUpdateStatusWithHdr 

func (to *Session) GetServerUpdateStatusWithHdr(hostName string, header http.Header) (tc.ServerUpdateStatus, ReqInf, error)

func (*Session) GetServers 

func (to *Session) GetServers(params *url.Values) ([]tc.Server, ReqInf, error)

GetServers returns a list of Servers. The 'params' parameter can be used to optionally pass URL "query string parameters" in the request. It returns, in order, the API response that Traffic Ops returned, a request info object, and any error that occurred. Deprecated: GetServers will be removed in 6.0. Use GetServersWithHdr.

func (*Session) GetServersChecks 

func (to *Session) GetServersChecks() ([]tc.GenericServerCheck, tc.Alerts, ReqInf, error)

GetServersChecks fetches check and meta information about servers from /servercheck.

func (*Session) GetServersShortNameSearch 

func (to *Session) GetServersShortNameSearch(shortname string) ([]string, tc.Alerts, ReqInf, error)

GetServersShortNameSearch returns all of the Host Names of servers that contain 'shortname'. Deprecated: GetServersShortNameSearch will be removed in 6.0. Use GetServersShortNameSearchWithHdr.

func (*Session) GetServersShortNameSearchWithHdr 

func (to *Session) GetServersShortNameSearchWithHdr(shortname string, header http.Header) ([]string, tc.Alerts, ReqInf, error)

func (*Session) GetServersWithHdr 

func (to *Session) GetServersWithHdr(params *url.Values, header http.Header) (tc.ServersV3Response, ReqInf, error)

GetServersWithHdr retrieves a list of servers using the given optional query string parameters and HTTP headers.

func (*Session) GetServiceCategories 

func (to *Session) GetServiceCategories(values *url.Values) ([]tc.ServiceCategory, ReqInf, error)

GetServiceCategories gets a list of service categories by the passed in url values.

func (*Session) GetServiceCategoriesWithHdr 

func (to *Session) GetServiceCategoriesWithHdr(values *url.Values, header http.Header) ([]tc.ServiceCategory, ReqInf, error)

GetServiceCategoriesWithHdr gets a list of service categories by the passed in url values and http headers.

func (*Session) GetStaticDNSEntries 

func (to *Session) GetStaticDNSEntries() ([]tc.StaticDNSEntry, ReqInf, error)

GetStaticDNSEntries returns a list of Static DNS Entrys. Deprecated: GetStaticDNSEntries will be removed in 6.0. Use GetStaticDNSEntriesWithHdr.

func (*Session) GetStaticDNSEntriesByHost 

func (to *Session) GetStaticDNSEntriesByHost(host string) ([]tc.StaticDNSEntry, ReqInf, error)

GetStaticDNSEntriesByHost GETs a Static DNS Entry by the Static DNS Entry's host. Deprecated: GetStaticDNSEntriesByHost will be removed in 6.0. Use GetStaticDNSEntriesByHostWithHdr.

func (*Session) GetStaticDNSEntriesByHostWithHdr 

func (to *Session) GetStaticDNSEntriesByHostWithHdr(host string, header http.Header) ([]tc.StaticDNSEntry, ReqInf, error)

func (*Session) GetStaticDNSEntriesWithHdr 

func (to *Session) GetStaticDNSEntriesWithHdr(header http.Header) ([]tc.StaticDNSEntry, ReqInf, error)

func (*Session) GetStaticDNSEntryByID 

func (to *Session) GetStaticDNSEntryByID(id int) ([]tc.StaticDNSEntry, ReqInf, error)

GetStaticDNSEntryByID GETs a Static DNS Entry by the Static DNS Entry's ID. Deprecated: GetStaticDNSEntryByID will be removed in 6.0. Use GetStaticDNSEntryByIDWithHdr.

func (*Session) GetStaticDNSEntryByIDWithHdr 

func (to *Session) GetStaticDNSEntryByIDWithHdr(id int, header http.Header) ([]tc.StaticDNSEntry, ReqInf, error)

func (*Session) GetStatusByID 

func (to *Session) GetStatusByID(id int) ([]tc.Status, ReqInf, error)

GetStatusByID GETs a Status by the Status ID. Deprecated: GetStatusByID will be removed in 6.0. Use GetStatusByIDWithHdr.

func (*Session) GetStatusByIDWithHdr 

func (to *Session) GetStatusByIDWithHdr(id int, header http.Header) ([]tc.Status, ReqInf, error)

func (*Session) GetStatusByName 

func (to *Session) GetStatusByName(name string) ([]tc.Status, ReqInf, error)

GetStatusByName GETs a Status by the Status name. Deprecated: GetStatusByName will be removed in 6.0. Use GetStatusByNameWithHdr.

func (*Session) GetStatusByNameWithHdr 

func (to *Session) GetStatusByNameWithHdr(name string, header http.Header) ([]tc.Status, ReqInf, error)

func (*Session) GetStatuses 

func (to *Session) GetStatuses() ([]tc.Status, ReqInf, error)

GetStatuses returns a list of Statuses. Deprecated: GetStatuses will be removed in 6.0. Use GetStatusesWithHdr.

func (*Session) GetStatusesWithHdr 

func (to *Session) GetStatusesWithHdr(header http.Header) ([]tc.Status, ReqInf, error)

func (*Session) GetSteeringTargets 

func (to *Session) GetSteeringTargets(dsID int) ([]tc.SteeringTargetNullable, ReqInf, error)

func (*Session) GetSummaryStats 

func (to *Session) GetSummaryStats(cdn, deliveryService, statName *string) (tc.StatsSummaryResponse, ReqInf, error)

GetSummaryStats gets a list of summary stats with the ability to filter on cdn,deliveryService and/or stat

func (*Session) GetSummaryStatsLastUpdated 

func (to *Session) GetSummaryStatsLastUpdated(statName *string) (tc.StatsSummaryLastUpdatedResponse, ReqInf, error)

GetSummaryStatsLastUpdated time of the last summary for a given stat

func (*Session) GetTopologies 

func (to *Session) GetTopologies() ([]tc.Topology, ReqInf, error)

GetTopologies returns all topologies. Deprecated: GetTopologies will be removed in 6.0. Use GetTopologiesWithHdr.

func (*Session) GetTopologiesWithHdr 

func (to *Session) GetTopologiesWithHdr(header http.Header) ([]tc.Topology, ReqInf, error)

func (*Session) GetTopology 

func (to *Session) GetTopology(name string) (*tc.Topology, ReqInf, error)

GetTopology returns the given topology by name. Deprecated: GetTopology will be removed in 6.0. Use GetTopologyWithHdr.

func (*Session) GetTopologyWithHdr 

func (to *Session) GetTopologyWithHdr(name string, header http.Header) (*tc.Topology, ReqInf, error)

func (*Session) GetTrafficMonitorConfig 

func (to *Session) GetTrafficMonitorConfig(cdn string) (*tc.TrafficMonitorConfig, ReqInf, error)

GetTrafficMonitorConfig returns the monitoring configuration for the CDN named by 'cdn'.

func (*Session) GetTrafficMonitorConfigMap 

func (to *Session) GetTrafficMonitorConfigMap(cdn string) (*tc.TrafficMonitorConfigMap, ReqInf, error)

GetTrafficMonitorConfigMap is functionally identical to GetTrafficMonitorConfig, except that it coerces the value returned by the API to the tc.TrafficMonitorConfigMap structure.

func (*Session) GetTypeByID 

func (to *Session) GetTypeByID(id int) ([]tc.Type, ReqInf, error)

GetTypeByID GETs a Type by the Type ID. Deprecated: GetTypeByID will be removed in 6.0. Use GetTypeByIDWithHdr.

func (*Session) GetTypeByIDWithHdr 

func (to *Session) GetTypeByIDWithHdr(id int, header http.Header) ([]tc.Type, ReqInf, error)

GetTypeByID GETs a Type by the Type ID, and filters by http header params in the request.

func (*Session) GetTypeByName 

func (to *Session) GetTypeByName(name string) ([]tc.Type, ReqInf, error)

GetTypeByName GETs a Type by the Type name. Deprecated: GetTypeByName will be removed in 6.0. Use GetTypeByNameWithHdr.

func (*Session) GetTypeByNameWithHdr 

func (to *Session) GetTypeByNameWithHdr(name string, header http.Header) ([]tc.Type, ReqInf, error)

func (*Session) GetTypes 

func (to *Session) GetTypes(useInTable ...string) ([]tc.Type, ReqInf, error)

GetTypes returns a list of Types. If a 'useInTable' parameter is passed, the returned Types are restricted to those with that exact 'useInTable' property. Only exactly 1 or exactly 0 'useInTable' parameters may be passed; passing more will result in an error being returned. Deprecated: GetTypes will be removed in 6.0. Use GetTypesWithHdr.

func (*Session) GetTypesWithHdr 

func (to *Session) GetTypesWithHdr(header http.Header, useInTable ...string) ([]tc.Type, ReqInf, error)

GetTypesWithHdr returns a list of Types, with an http header and 'useInTable' parameters. If a 'useInTable' parameter is passed, the returned Types are restricted to those with that exact 'useInTable' property. Only exactly 1 or exactly 0 'useInTable' parameters may be passed; passing more will result in an error being returned.

func (*Session) GetUserByID deprecated 

func (to *Session) GetUserByID(id int) ([]tc.User, ReqInf, error)

Deprecated: GetUserByID will be removed in 6.0. Use GetUserByIDWithHdr.

func (*Session) GetUserByIDWithHdr 

func (to *Session) GetUserByIDWithHdr(id int, header http.Header) ([]tc.User, ReqInf, error)

func (*Session) GetUserByUsername deprecated 

func (to *Session) GetUserByUsername(username string) ([]tc.User, ReqInf, error)

Deprecated: GetUserByUsername will be removed in 6.0. Use GetUserByUsernameWithHdr.

func (*Session) GetUserByUsernameWithHdr 

func (to *Session) GetUserByUsernameWithHdr(username string, header http.Header) ([]tc.User, ReqInf, error)

func (*Session) GetUserCurrent 

func (to *Session) GetUserCurrent() (*tc.UserCurrent, ReqInf, error)

GetUserCurrent gets information about the current user Deprecated: GetUserCurrent will be removed in 6.0. Use GetUserCurrentWithHdr.

func (*Session) GetUserCurrentWithHdr 

func (to *Session) GetUserCurrentWithHdr(header http.Header) (*tc.UserCurrent, ReqInf, error)

func (*Session) GetUsers 

func (to *Session) GetUsers() ([]tc.User, ReqInf, error)

GetUsers returns all users accessible from current user Deprecated: GetUsers will be removed in 6.0. Use GetUsersWithHdr.

func (*Session) GetUsersByRole 

func (to *Session) GetUsersByRole(roleName string) ([]tc.User, ReqInf, error)

GetUsersByRole returns all users accessible from current user for a given role Deprecated: GetUsersByRole will be removed in 6.0. Use GetUsersByRoleWithHdr.

func (*Session) GetUsersByRoleWithHdr 

func (to *Session) GetUsersByRoleWithHdr(roleName string, header http.Header) ([]tc.User, ReqInf, error)

func (*Session) GetUsersWithHdr 

func (to *Session) GetUsersWithHdr(header http.Header) ([]tc.User, ReqInf, error)

func (*Session) ImportProfile 

func (to *Session) ImportProfile(importRequest *tc.ProfileImportRequest) (*tc.ProfileImportResponse, ReqInf, error)

ImportProfile imports an exported Profile.

func (*Session) InsertServerCheckStatus 

func (to *Session) InsertServerCheckStatus(status tc.ServercheckRequestNullable) (*tc.ServercheckPostResponse, ReqInf, error)

InsertServerCheckStatus Will insert/update the servercheck value based on if it already exists or not.

func (*Session) LatestAPIVersion 

func (sn *Session) LatestAPIVersion() string

LatestAPIVersion returns the latest Traffic Ops API version this client supports.

func (*Session) Ping 

func (to *Session) Ping() (map[string]string, ReqInf, error)

Ping returns a static json object to show that traffic_ops is responsive

func (*Session) PostDeliveryServiceRegexesByDSID 

func (to *Session) PostDeliveryServiceRegexesByDSID(dsID int, regex tc.DeliveryServiceRegexPost) (tc.Alerts, ReqInf, error)

func (*Session) RawRequest 

func (to *Session) RawRequest(method, path string, body []byte) (*http.Response, net.Addr, error)

RawRequest performs the actual HTTP request to Traffic Ops, simply, without trying to refresh the cookie if an Unauthorized code is returned. Returns the response, the remote address of the Traffic Ops instance used, and any error. The returned net.Addr is guaranteed to be either nil or valid, even if the returned error is not nil. Callers are encouraged to check and use the net.Addr if an error is returned, and use the remote address in their own error messages. This violates the Go idiom that a non-nil error implies all other values are undefined, but it's more straightforward than alternatives like typecasting. Deprecated: RawRequest will be removed in 6.0. Use RawRequestWithHdr.

func (*Session) RawRequestWithHdr 

func (to *Session) RawRequestWithHdr(method, path string, body []byte, header http.Header) (*http.Response, net.Addr, error)

func (*Session) RegisterNewUser 

func (to *Session) RegisterNewUser(tenantID uint, roleID uint, email rfc.EmailAddress) (tc.Alerts, ReqInf, error)

RegisterNewUser requests the registration of a new user with the given tenant ID and role ID, through their email.

func (*Session) ReplaceFederationResolverMappingsForCurrentUser 

func (to *Session) ReplaceFederationResolverMappingsForCurrentUser(mappings tc.DeliveryServiceFederationResolverMappingRequest) (tc.Alerts, ReqInf, error)

ReplaceFederationResolverMappingsForCurrentUser replaces any and all Federation Resolver mappings on all Federations assigned to the currently authenticated user. This will first remove ALL Federation Resolver mappings for ALL Federations assigned to the currently authenticated user, as well as deleting ALL of the Federation Resolvers themselves. In other words, calling this is equivalent to a call to DeleteFederationResolverMappingsForCurrentUser followed by a call to AddFederationResolverMappingsForCurrentUser .

func (*Session) SafeDeliveryServiceUpdateV30WithHdr 

func (to *Session) SafeDeliveryServiceUpdateV30WithHdr(id int, r tc.DeliveryServiceSafeUpdateRequest, header http.Header) (tc.DeliveryServiceNullableV30, ReqInf, error)

SafeDeliveryServiceUpdateV30WithHdr updates the "safe" fields of the Delivery Service identified by the integral, unique identifier 'id'.

func (*Session) SetCachegroupDeliveryServices 

func (to *Session) SetCachegroupDeliveryServices(cgID int, dsIDs []int) (tc.CacheGroupPostDSRespResponse, ReqInf, error)

func (*Session) SetDeliveryServiceUser 

func (to *Session) SetDeliveryServiceUser(userID int, dses []int, replace bool) (*tc.UserDeliveryServicePostResponse, error)

SetUserDeliveryService associates the given delivery services with the given user.

func (*Session) SetServerQueueUpdate 

func (to *Session) SetServerQueueUpdate(serverID int, queueUpdate bool) (tc.ServerQueueUpdateResponse, ReqInf, error)

SetServerQueueUpdate updates a server's status and returns the response.

func (*Session) SetUpdateServerStatuses 

func (to *Session) SetUpdateServerStatuses(serverName string, updateStatus *bool, revalStatus *bool) (ReqInf, error)

UpdateServerStatus updates a server's queue status and/or reval status. Either updateStatus or revalStatus may be nil, in which case that status isn't updated (but not both, because that wouldn't do anything).

func (*Session) SnapshotCRConfig 

func (to *Session) SnapshotCRConfig(cdn string) (ReqInf, error)

SnapshotCRConfig snapshots a CDN by name. Deprecated: SnapshotCRConfig will be removed in 6.0. Use SnapshotCRConfigWithHdr.

func (*Session) SnapshotCRConfigByID 

func (to *Session) SnapshotCRConfigByID(id int) (tc.Alerts, ReqInf, error)

SnapshotCDNByID snapshots a CDN by ID.

func (*Session) SnapshotCRConfigWithHdr 

func (to *Session) SnapshotCRConfigWithHdr(cdn string, header http.Header) (ReqInf, error)

func (*Session) Steering deprecated 

func (to *Session) Steering() ([]tc.Steering, ReqInf, error)

Deprecated: Steering will be removed in 6.0. Use SteeringWithHdr.

func (*Session) SteeringWithHdr 

func (to *Session) SteeringWithHdr(header http.Header) ([]tc.Steering, ReqInf, error)

func (*Session) Tenant 

func (to *Session) Tenant(id string) (*tc.Tenant, ReqInf, error)

Tenant gets the Tenant identified by the passed integral, unique identifer - which must be passed as a string. Deprecated: Tenant will be removed in 6.0. Use TenantWithHdr.

func (*Session) TenantByName 

func (to *Session) TenantByName(name string) (*tc.Tenant, ReqInf, error)

TenantByName gets the Tenant with the name it's passed. Deprecated: TenantByName will be removed in 6.0. Use TenantByNameWithHdr.

func (*Session) TenantByNameWithHdr 

func (to *Session) TenantByNameWithHdr(name string, header http.Header) (*tc.Tenant, ReqInf, error)

func (*Session) TenantWithHdr 

func (to *Session) TenantWithHdr(id string, header http.Header) (*tc.Tenant, ReqInf, error)

func (*Session) Tenants 

func (to *Session) Tenants() ([]tc.Tenant, ReqInf, error)

Tenants gets an array of Tenants. Deprecated: Tenants will be removed in 6.0. Use TenantsWithHdr.

func (*Session) TenantsWithHdr 

func (to *Session) TenantsWithHdr(header http.Header) ([]tc.Tenant, ReqInf, error)

func (*Session) TopologiesQueueUpdate 

func (to *Session) TopologiesQueueUpdate(topologyName tc.TopologyName, req tc.TopologiesQueueUpdateRequest) (tc.TopologiesQueueUpdateResponse, ReqInf, error)

func (*Session) UpdateASNByID 

func (to *Session) UpdateASNByID(id int, entity tc.ASN) (tc.Alerts, ReqInf, error)

UpdateASNByID updates a ASN by ID

func (*Session) UpdateCDNByID 

func (to *Session) UpdateCDNByID(id int, cdn tc.CDN) (tc.Alerts, ReqInf, error)

UpdateCDNByID updates a CDN by ID. Deprecated: UpdateCDNByID will be removed in 6.0. Use UpdateCDNByIDWithHdr.

func (*Session) UpdateCDNByIDWithHdr 

func (to *Session) UpdateCDNByIDWithHdr(id int, cdn tc.CDN, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateCDNFederationsByID deprecated 

func (to *Session) UpdateCDNFederationsByID(f tc.CDNFederation, CDNName string, ID int) (*tc.UpdateCDNFederationResponse, ReqInf, error)

Deprecated: UpdateCDNFederationsByID will be removed in 6.0. Use UpdateCDNFederationsByIDWithHdr.

func (*Session) UpdateCDNFederationsByIDWithHdr 

func (to *Session) UpdateCDNFederationsByIDWithHdr(f tc.CDNFederation, CDNName string, ID int, h http.Header) (*tc.UpdateCDNFederationResponse, ReqInf, error)

func (*Session) UpdateCacheGroupNullableByID 

func (to *Session) UpdateCacheGroupNullableByID(id int, cachegroup tc.CacheGroupNullable) (*tc.CacheGroupDetailResponse, ReqInf, error)

Update a CacheGroup by ID. Deprecated: UpdateCacheGroupNullableByID will be removed in 6.0. Use UpdateCacheGroupNullableByIDWithHdr.

func (*Session) UpdateCacheGroupNullableByIDWithHdr 

func (to *Session) UpdateCacheGroupNullableByIDWithHdr(id int, cachegroup tc.CacheGroupNullable, h http.Header) (*tc.CacheGroupDetailResponse, ReqInf, error)

func (*Session) UpdateCoordinateByID 

func (to *Session) UpdateCoordinateByID(id int, coordinate tc.Coordinate) (tc.Alerts, ReqInf, error)

Update a Coordinate by ID Deprecated: UpdateCoordinateByID will be removed in 6.0. Use UpdateCoordinateByIDWithHdr.

func (*Session) UpdateCoordinateByIDWithHdr 

func (to *Session) UpdateCoordinateByIDWithHdr(id int, coordinate tc.Coordinate, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateCurrentUser 

func (to *Session) UpdateCurrentUser(u tc.User) (*tc.UpdateUserResponse, ReqInf, error)

UpdateCurrentUser replaces the current user data with the provided tc.User structure.

func (*Session) UpdateDeliveryServiceNullable deprecated 

func (to *Session) UpdateDeliveryServiceNullable(id string, ds *tc.DeliveryServiceNullable) (*tc.UpdateDeliveryServiceNullableResponse, error)

UpdateDeliveryServiceNullable updates the DeliveryService matching the ID it's passed with the DeliveryService it is passed.

Warning: This method coerces its returned data into an APIv1.5 format, and only accepts input in an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, UpdateDeliveryServiceV30WithHdr.

func (*Session) UpdateDeliveryServiceNullableWithHdr 

func (to *Session) UpdateDeliveryServiceNullableWithHdr(id string, ds *tc.DeliveryServiceNullable, header http.Header) (*tc.UpdateDeliveryServiceNullableResponse, error)

func (*Session) UpdateDeliveryServiceRequestByID 

func (to *Session) UpdateDeliveryServiceRequestByID(id int, dsr tc.DeliveryServiceRequest) (tc.Alerts, ReqInf, error)

Update a DeliveryServiceRequest by ID Deprecated: UpdateDeliveryServiceRequestByID will be removed in 6.0. Use UpdateDeliveryServiceRequestByIDWithHdr.

func (*Session) UpdateDeliveryServiceRequestByIDWithHdr 

func (to *Session) UpdateDeliveryServiceRequestByIDWithHdr(id int, dsr tc.DeliveryServiceRequest, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateDeliveryServiceRequestCommentByID 

func (to *Session) UpdateDeliveryServiceRequestCommentByID(id int, comment tc.DeliveryServiceRequestComment) (tc.Alerts, ReqInf, error)

Update a delivery service request by ID Deprecated: UpdateDeliveryServiceRequestCommentByID will be removed in 6.0. Use UpdateDeliveryServiceRequestCommentByIDWithHdr.

func (*Session) UpdateDeliveryServiceRequestCommentByIDWithHdr 

func (to *Session) UpdateDeliveryServiceRequestCommentByIDWithHdr(id int, comment tc.DeliveryServiceRequestComment, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateDeliveryServiceSafe deprecated 

func (to *Session) UpdateDeliveryServiceSafe(id int, ds tc.DeliveryServiceSafeUpdateRequest) ([]tc.DeliveryServiceNullable, ReqInf, error)

UpdateDeliveryServiceSafe updates the given Delivery Service identified by 'id' with the given "safe" fields.

Warning: This method coerces its returned data into an APIv1.5 format.

Deprecated: Please used versioned library imports in the future, and versioned methods, specifically, for API v3.0 - in this case, SafeDeliveryServiceUpdateV30WithHdr.

func (*Session) UpdateDeliveryServiceV30WithHdr 

func (to *Session) UpdateDeliveryServiceV30WithHdr(id int, ds tc.DeliveryServiceNullableV30, header http.Header) (tc.DeliveryServiceNullableV30, ReqInf, error)

UpdateDeliveryServiceV30WithHdr replaces the Delivery Service identified by the integral, unique identifier 'id' with the one it's passed.

func (*Session) UpdateDivisionByID 

func (to *Session) UpdateDivisionByID(id int, division tc.Division) (tc.Alerts, ReqInf, error)

Update a Division by ID Deprecated: UpdateDivisionByID will be removed in 6.0. Use UpdateDivisionByIDWithHdr.

func (*Session) UpdateDivisionByIDWithHdr 

func (to *Session) UpdateDivisionByIDWithHdr(id int, division tc.Division, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateInvalidationJob 

func (to *Session) UpdateInvalidationJob(job tc.InvalidationJob) (tc.Alerts, ReqInf, error)

Updates a Content Invalidation Job

func (*Session) UpdateOriginByID 

func (to *Session) UpdateOriginByID(id int, origin tc.Origin) (*tc.OriginDetailResponse, ReqInf, error)

Update an Origin by ID Deprecated: UpdateOriginByID will be removed in 6.0. Use UpdateOriginByIDWithHdr.

func (*Session) UpdateOriginByIDWithHdr 

func (to *Session) UpdateOriginByIDWithHdr(id int, origin tc.Origin, header http.Header) (*tc.OriginDetailResponse, ReqInf, error)

func (*Session) UpdateParameterByID 

func (to *Session) UpdateParameterByID(id int, pl tc.Parameter) (tc.Alerts, ReqInf, error)

UpdateParameterByID performs a PUT to update a Parameter by ID. Deprecated: UpdateParameterByID will be removed in 6.0. Use UpdateParameterByIDWithHdr.

func (*Session) UpdateParameterByIDWithHdr 

func (to *Session) UpdateParameterByIDWithHdr(id int, pl tc.Parameter, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdatePhysLocationByID 

func (to *Session) UpdatePhysLocationByID(id int, pl tc.PhysLocation) (tc.Alerts, ReqInf, error)

Update a PhysLocation by ID Deprecated: UpdatePhysLocationByID will be removed in 6.0. Use UpdatePhysLocationByIDWithHdr.

func (*Session) UpdatePhysLocationByIDWithHdr 

func (to *Session) UpdatePhysLocationByIDWithHdr(id int, pl tc.PhysLocation, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateProfileByID 

func (to *Session) UpdateProfileByID(id int, pl tc.Profile) (tc.Alerts, ReqInf, error)

UpdateProfileByID updates a Profile by ID. Deprecated: UpdateProfileByID will be removed in 6.0. Use UpdateProfileByIDWithHdr.

func (*Session) UpdateProfileByIDWithHdr 

func (to *Session) UpdateProfileByIDWithHdr(id int, pl tc.Profile, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateRegionByID 

func (to *Session) UpdateRegionByID(id int, region tc.Region) (tc.Alerts, ReqInf, error)

UpdateRegionByID updates a Region by ID. Deprecated: UpdateRegionByID will be removed in 6.0. Use UpdateRegionByIDWithHdr.

func (*Session) UpdateRegionByIDWithHdr 

func (to *Session) UpdateRegionByIDWithHdr(id int, region tc.Region, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateRoleByID 

func (to *Session) UpdateRoleByID(id int, role tc.Role) (tc.Alerts, ReqInf, int, error)

UpdateRoleByID updates a Role by ID. Deprecated: UpdateRoleByID will be removed in 6.0. Use UpdateRoleByIDWithHdr.

func (*Session) UpdateRoleByIDWithHdr 

func (to *Session) UpdateRoleByIDWithHdr(id int, role tc.Role, header http.Header) (tc.Alerts, ReqInf, int, error)

func (*Session) UpdateServerByID 

func (to *Session) UpdateServerByID(id int, server tc.Server) (tc.Alerts, ReqInf, error)

UpdateServerByID updates a Server by ID. Deprecated: UpdateServerByID will be removed in 6.0. Use UpdateServerByIDWithHdr.

func (*Session) UpdateServerByIDWithHdr 

func (to *Session) UpdateServerByIDWithHdr(id int, server tc.ServerV30, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateServerStatus 

func (to *Session) UpdateServerStatus(serverID int, req tc.ServerPutStatus) (*tc.Alerts, ReqInf, error)

UpdateServerStatus updates a server's status and returns the response.

func (*Session) UpdateServiceCategoryByName 

func (to *Session) UpdateServiceCategoryByName(name string, serviceCategory tc.ServiceCategory, header http.Header) (tc.Alerts, ReqInf, error)

UpdateServiceCategoryByName updates a service category by its unique name.

func (*Session) UpdateStaticDNSEntryByID 

func (to *Session) UpdateStaticDNSEntryByID(id int, sdns tc.StaticDNSEntry) (tc.Alerts, ReqInf, int, error)

UpdateStaticDNSEntryByID updates a Static DNS Entry by ID. Deprecated: UpdateStaticDNSEntryByID will be removed in 6.0. Use UpdateStaticDNSEntryByIDWithHdr.

func (*Session) UpdateStaticDNSEntryByIDWithHdr 

func (to *Session) UpdateStaticDNSEntryByIDWithHdr(id int, sdns tc.StaticDNSEntry, header http.Header) (tc.Alerts, ReqInf, int, error)

func (*Session) UpdateStatusByID 

func (to *Session) UpdateStatusByID(id int, status tc.Status) (tc.Alerts, ReqInf, error)

UpdateStatusByID updates a Status by ID. Deprecated: UpdateStatusByID will be removed in 6.0. Use UpdateStatusByIDWithHdr.

func (*Session) UpdateStatusByIDWithHdr 

func (to *Session) UpdateStatusByIDWithHdr(id int, status tc.Status, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateSteeringTarget deprecated 

func (to *Session) UpdateSteeringTarget(st tc.SteeringTargetNullable) (tc.Alerts, ReqInf, error)

Deprecated: UpdateSteeringTarget will be removed in 6.0. Use UpdateSteeringTargetWithHdr.

func (*Session) UpdateSteeringTargetWithHdr 

func (to *Session) UpdateSteeringTargetWithHdr(st tc.SteeringTargetNullable, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateTenant 

func (to *Session) UpdateTenant(id string, t *tc.Tenant) (*tc.TenantResponse, error)

UpdateTenant updates the Tenant matching the ID it's passed with the Tenant it is passed. Deprecated: UpdateTenant will be removed in 6.0. Use UpdateTenantWithHdr.

func (*Session) UpdateTenantWithHdr 

func (to *Session) UpdateTenantWithHdr(id string, t *tc.Tenant, header http.Header) (*tc.TenantResponse, ReqInf, error)

func (*Session) UpdateTopology 

func (to *Session) UpdateTopology(name string, t tc.Topology) (*tc.TopologyResponse, ReqInf, error)

UpdateTopology updates a Topology by name.

func (*Session) UpdateTypeByID 

func (to *Session) UpdateTypeByID(id int, typ tc.Type) (tc.Alerts, ReqInf, error)

UpdateTypeByID updates a Type by ID. Deprecated: UpdateTypeByID will be removed in 6.0. Use UpdateTypeByIDWithHdr.

func (*Session) UpdateTypeByIDWithHdr 

func (to *Session) UpdateTypeByIDWithHdr(id int, typ tc.Type, header http.Header) (tc.Alerts, ReqInf, error)

func (*Session) UpdateUserByID 

func (to *Session) UpdateUserByID(id int, u *tc.User) (*tc.UpdateUserResponse, ReqInf, error)

UpdateUserByID updates user with the given id

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.