fastly

package
v1.0.12-f83f6b8 Latest Latest
Warning

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

 Go to latest Published: Apr 21, 2021 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

package fastly is simple package tool to interact with the Fastly CDN API

Index

Constants

View Source 
const (
	//HeaderContentType for content type
	HeaderContentType string = "Content-Type"

	//HeaderFastlyKey Fastly API Key Header
	HeaderFastlyKey string = "Fastly-Key"

	//MIMEApplicationJSON content type for JSON
	MIMEApplicationJSON string = "application/json"

	//HTTPMethodPurge Fastly extension http method for purging the CDN
	HTTPMethodPurge string = "PURGE"
)
View Source 
const (
	//RespSucessfullyPurgedAllObjects for purging an entire service
	RespSucessfullyPurgedAllObjects string = "Successfully purged all objects from the service"

	//RespSucessfullyPurgedObject for purging a single object
	RespSucessfullyPurgedObject string = "Successfully purged object"
)

Variables

View Source 
var (
	//ErrNoAPIKeySet is returned when no API Key set
	ErrNoAPIKeySet = errors.New("Fastly API key not set. Please export $FASTLYAPIKEY=x")

	//ErrAPIKeyDoesntHaveAccess is returned when the API Keys doesnt have access to the account or services
	ErrAPIKeyDoesntHaveAccess = errors.New("API Key doesnt have access to account or Service. Please be aware that the API key needs to have `Read-only access (global:read)` to lookup services by name")

	//ErrNoServiceWithNameExists is returned when no service found with described name
	ErrNoServiceWithNameExists = errors.New("No service called with name exists")

	//ErrNoObjectSetForPurge is returned when no object is declare
	ErrNoObjectSetForPurge = errors.New("No object set to purge")

	//ErrObjectIsNotVaildateURI is returned when the object declared isnt an valid URI
	ErrObjectIsNotVaildateURI = errors.New("Object is not a valid URI")

	//ErrFailedToPurgeService is returned when a purge failed for a service
	ErrFailedToPurgeService = errors.New("Failed to purge the Service")

	//ErrFailedToPurgeObject is returned when a purge failed for an object
	ErrFailedToPurgeObject = errors.New("Failed to purge the Object")

	//ErrFailedToRetrieveServiceDetails is returned when a call failed to restrive a Service
	ErrFailedToRetrieveServiceDetails = errors.New("Failed to retrieve service details")
)

Functions

This section is empty.

Types

type Fastly 

type Fastly struct {
	// contains filtered or unexported fields
}

Fastly struct for fastly client connection

func New 

func New() *Fastly

New constructor

func (*Fastly) GetService 

func (f *Fastly) GetService(serviceName string) (string, error)

GetService gets all details for a fastly service via it's friendly name

func (*Fastly) GetServiceBackends 

func (f *Fastly) GetServiceBackends(serviceName string) (string, error)

GetServiceBackends get all backends for a service

func (*Fastly) GetServiceDomains 

func (f *Fastly) GetServiceDomains(serviceName string) (string, error)

GetServiceDomains get public cnames for service

func (*Fastly) PurgeAllObjects 

func (f *Fastly) PurgeAllObjects(serviceName string) (string, error)

PurgeAllObjects for service

func (*Fastly) PurgeObject 

func (f *Fastly) PurgeObject(serviceName string, object string) (string, error)

PurgeObject an object from the service

type Service 

type Service struct {
	ActiveVersion struct {
		Active   bool `json:"active"`
		Backends []struct {
			Address             string      `json:"address"`
			AutoLoadbalance     bool        `json:"auto_loadbalance"`
			BetweenBytesTimeout int         `json:"between_bytes_timeout"`
			ClientCert          interface{} `json:"client_cert"`
			Comment             string      `json:"comment"`
			ConnectTimeout      int         `json:"connect_timeout"`
			ErrorThreshold      int         `json:"error_threshold"`
			FirstByteTimeout    int         `json:"first_byte_timeout"`
			Healthcheck         string      `json:"healthcheck"`
			Hostname            string      `json:"hostname"`
			Ipv4                interface{} `json:"ipv4"`
			Ipv6                interface{} `json:"ipv6"`
			MaxConn             int         `json:"max_conn"`
			Name                string      `json:"name"`
			Port                int         `json:"port"`
			RequestCondition    string      `json:"request_condition"`
			Shield              string      `json:"shield"`
			SslCaCert           interface{} `json:"ssl_ca_cert"`
			SslClientCert       interface{} `json:"ssl_client_cert"`
			SslClientKey        interface{} `json:"ssl_client_key"`
			SslHostname         string      `json:"ssl_hostname"`
			UseSsl              bool        `json:"use_ssl"`
			Weight              int         `json:"weight"`
		} `json:"backends"`
		CacheSettings []interface{} `json:"cache_settings"`
		Comment       string        `json:"comment"`
		Conditions    []interface{} `json:"conditions"`
		Deployed      interface{}   `json:"deployed"`
		Directors     []interface{} `json:"directors"`
		Domains       []struct {
			Comment string `json:"comment"`
			Name    string `json:"name"`
		} `json:"domains"`
		Gzips []struct {
			CacheCondition string `json:"cache_condition"`
			ContentTypes   string `json:"content_types"`
			Extensions     string `json:"extensions"`
			Name           string `json:"name"`
		} `json:"gzips"`
		Headers          []interface{} `json:"headers"`
		Healthchecks     []interface{} `json:"healthchecks"`
		InheritServiceID interface{}   `json:"inherit_service_id"`
		Locked           bool          `json:"locked"`
		Matches          []interface{} `json:"matches"`
		Number           int           `json:"number"`
		Origins          []interface{} `json:"origins"`
		RequestSettings  []struct {
			Action           interface{} `json:"action"`
			BypassBusyWait   interface{} `json:"bypass_busy_wait"`
			DefaultHost      string      `json:"default_host"`
			ForceMiss        interface{} `json:"force_miss"`
			ForceSsl         string      `json:"force_ssl"`
			GeoHeaders       interface{} `json:"geo_headers"`
			HashKeys         string      `json:"hash_keys"`
			MaxStaleAge      string      `json:"max_stale_age"`
			Name             string      `json:"name"`
			RequestCondition string      `json:"request_condition"`
			TimerSupport     string      `json:"timer_support"`
			Xff              string      `json:"xff"`
		} `json:"request_settings"`
		ResponseObjects []interface{} `json:"response_objects"`
		ServiceID       string        `json:"service_id"`
		Settings        struct {
			GeneralDefaultHost string `json:"general.default_host"`
			GeneralDefaultPci  int    `json:"general.default_pci"`
			GeneralDefaultTTL  int    `json:"general.default_ttl"`
		} `json:"settings"`
		Staging   interface{}   `json:"staging"`
		Testing   interface{}   `json:"testing"`
		Vcls      []interface{} `json:"vcls"`
		Wordpress []interface{} `json:"wordpress"`
	} `json:"active_version"`
	Comment    string `json:"comment"`
	CustomerID string `json:"customer_id"`
	ID         string `json:"id"`
	Name       string `json:"name"`
	Version    struct {
		Active   bool `json:"active"`
		Backends []struct {
			Address             string      `json:"address"`
			AutoLoadbalance     bool        `json:"auto_loadbalance"`
			BetweenBytesTimeout int         `json:"between_bytes_timeout"`
			ClientCert          interface{} `json:"client_cert"`
			Comment             string      `json:"comment"`
			ConnectTimeout      int         `json:"connect_timeout"`
			ErrorThreshold      int         `json:"error_threshold"`
			FirstByteTimeout    int         `json:"first_byte_timeout"`
			Healthcheck         string      `json:"healthcheck"`
			Hostname            string      `json:"hostname"`
			Ipv4                interface{} `json:"ipv4"`
			Ipv6                interface{} `json:"ipv6"`
			MaxConn             int         `json:"max_conn"`
			Name                string      `json:"name"`
			Port                int         `json:"port"`
			RequestCondition    string      `json:"request_condition"`
			Shield              string      `json:"shield"`
			SslCaCert           interface{} `json:"ssl_ca_cert"`
			SslClientCert       interface{} `json:"ssl_client_cert"`
			SslClientKey        interface{} `json:"ssl_client_key"`
			SslHostname         string      `json:"ssl_hostname"`
			UseSsl              bool        `json:"use_ssl"`
			Weight              int         `json:"weight"`
		} `json:"backends"`
		CacheSettings []interface{} `json:"cache_settings"`
		Comment       string        `json:"comment"`
		Conditions    []interface{} `json:"conditions"`
		Deployed      interface{}   `json:"deployed"`
		Directors     []interface{} `json:"directors"`
		Domains       []struct {
			Comment string `json:"comment"`
			Name    string `json:"name"`
		} `json:"domains"`
		Gzips []struct {
			CacheCondition string `json:"cache_condition"`
			ContentTypes   string `json:"content_types"`
			Extensions     string `json:"extensions"`
			Name           string `json:"name"`
		} `json:"gzips"`
		Headers          []interface{} `json:"headers"`
		Healthchecks     []interface{} `json:"healthchecks"`
		InheritServiceID interface{}   `json:"inherit_service_id"`
		Locked           bool          `json:"locked"`
		Matches          []interface{} `json:"matches"`
		Number           int           `json:"number"`
		Origins          []interface{} `json:"origins"`
		RequestSettings  []struct {
			Action           interface{} `json:"action"`
			BypassBusyWait   interface{} `json:"bypass_busy_wait"`
			DefaultHost      string      `json:"default_host"`
			ForceMiss        interface{} `json:"force_miss"`
			ForceSsl         string      `json:"force_ssl"`
			GeoHeaders       interface{} `json:"geo_headers"`
			HashKeys         string      `json:"hash_keys"`
			MaxStaleAge      string      `json:"max_stale_age"`
			Name             string      `json:"name"`
			RequestCondition string      `json:"request_condition"`
			TimerSupport     string      `json:"timer_support"`
			Xff              string      `json:"xff"`
		} `json:"request_settings"`
		ResponseObjects []interface{} `json:"response_objects"`
		ServiceID       string        `json:"service_id"`
		Settings        struct {
			GeneralDefaultHost string `json:"general.default_host"`
			GeneralDefaultPci  int    `json:"general.default_pci"`
			GeneralDefaultTTL  int    `json:"general.default_ttl"`
		} `json:"settings"`
		Staging   interface{}   `json:"staging"`
		Testing   interface{}   `json:"testing"`
		Vcls      []interface{} `json:"vcls"`
		Wordpress []interface{} `json:"wordpress"`
	} `json:"version"`
	Versions []struct {
		Active           bool        `json:"active"`
		Comment          string      `json:"comment"`
		CreatedAt        string      `json:"created_at"`
		DeletedAt        interface{} `json:"deleted_at"`
		Deployed         interface{} `json:"deployed"`
		InheritServiceID interface{} `json:"inherit_service_id"`
		Locked           bool        `json:"locked"`
		Number           int         `json:"number"`
		ServiceID        string      `json:"service_id"`
		Staging          interface{} `json:"staging"`
		Testing          interface{} `json:"testing"`
		UpdatedAt        string      `json:"updated_at"`
	} `json:"versions"`
}

Service is a fastly service from details lookup

type ServiceSearchResult 

type ServiceSearchResult struct {
	Comment    string `json:"comment"`
	CustomerID string `json:"customer_id"`
	ID         string `json:"id"`
	Name       string `json:"name"`
	Versions   []struct {
		Active          bool          `json:"active"`
		Backend         []interface{} `json:"backend"`
		CacheSettings   []interface{} `json:"cache_settings"`
		Comment         string        `json:"comment"`
		Condition       []interface{} `json:"condition"`
		Created         string        `json:"created"`
		Deleted         string        `json:"deleted"`
		Deployed        bool          `json:"deployed"`
		Director        []interface{} `json:"director"`
		Domain          []interface{} `json:"domain"`
		Gzip            []interface{} `json:"gzip"`
		Header          []interface{} `json:"header"`
		Healthcheck     []interface{} `json:"healthcheck"`
		Locked          bool          `json:"locked"`
		LoggingSyslog   []interface{} `json:"logging_syslog"`
		Number          int           `json:"number"`
		RequestSettings []interface{} `json:"request_settings"`
		ResponseObject  []interface{} `json:"response_object"`
		ServiceID       string        `json:"service_id"`
		Settings        struct {
			GeneralDefaultHost string `json:"general.default_host"`
			GeneralDefaultPci  int    `json:"general.default_pci"`
			GeneralDefaultTTL  int    `json:"general.default_ttl"`
		} `json:"settings"`
		Staging   bool          `json:"staging"`
		Testing   bool          `json:"testing"`
		Updated   string        `json:"updated"`
		Vcl       []interface{} `json:"vcl"`
		Waf       []interface{} `json:"waf"`
		Wordpress []interface{} `json:"wordpress"`
	} `json:"versions"`
}

ServiceSearchResult is a result from search by service name

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.