redirect

Documentation

Index

• type Certificate
  • func NewCertificate(domain string) *Certificate
• type CertificateList
• type Configuration
  • func NewConfiguration(domain string, path string, target string, tags []string, ...) *Configuration
  • func NewConfigurationMinimal(domain string, path string, target string) *Configuration
• type ConfigurationList
• type ForwardingMode
  • func ParseForwardingMode(str string) (ForwardingMode, bool)
  • func (s ForwardingMode) String() string
• type ForwardingType
  • func ParseForwardingType(str string) (ForwardingType, bool)
  • func (s ForwardingType) String() string

Types

type Certificate

type Certificate struct {
	ID          *string `json:"id,omitempty"`
	Domain      string  `json:"domain,omitempty"`
	Certificate *string `json:"certificate,omitempty"`
	ValidFrom   *int64  `json:"valid_from,omitempty"`
	ValidUntil  *int64  `json:"valid_until,omitempty"`
	Processing  *bool   `json:"processing,omitempty"`
	Errors      *string `json:"errors,omitempty"`
	LastUpdated *int64  `json:"last_updated,omitempty"`
}

Certificate represents an NS1 redirect certificate object

func NewCertificate

func NewCertificate(domain string) *Certificate

NewCertificate creates a new redirect certificate object with the given domain

type CertificateList

type CertificateList struct {
	After   *string        `json:"after,omitempty"`
	Count   int64          `json:"count,omitempty"`
	Limit   *int64         `json:"limit,omitempty"`
	Results []*Certificate `json:"results"`
	Total   int64          `json:"total,omitempty"`
}

CertificateList represents an NS1 redirect certificate list object

type Configuration

type Configuration struct {
	ID              *string         `json:"id,omitempty"`
	CertificateID   *string         `json:"certificate_id,omitempty"`
	Domain          string          `json:"domain,omitempty"`
	Path            string          `json:"path,omitempty"`
	Target          string          `json:"target,omitempty"`
	Tags            []string        `json:"tags"`
	ForwardingMode  *ForwardingMode `json:"forwarding_mode,omitempty"`
	ForwardingType  *ForwardingType `json:"forwarding_type,omitempty"`
	HttpsEnabled    *bool           `json:"https_enabled,omitempty"`
	HttpsForced     *bool           `json:"https_forced,omitempty"`
	QueryForwarding *bool           `json:"query_forwarding,omitempty"`
	LastUpdated     *int64          `json:"last_updated,omitempty"`
}

Certificate represents an NS1 redirect configuration object

func NewConfiguration

func NewConfiguration(
	domain string,
	path string,
	target string,
	tags []string,
	fwMode *ForwardingMode,
	fwType *ForwardingType,
	httpsEnabled *bool,
	httpsForced *bool,
	queryFwd *bool,
) *Configuration

NewConfiguration creates a new configuration with the given parameters

func NewConfigurationMinimal

func NewConfigurationMinimal(domain string, path string, target string) *Configuration

NewConfiguration creates a new configuration with the given parameters

type ConfigurationList

type ConfigurationList struct {
	After   *string          `json:"after,omitempty"`
	Count   int64            `json:"count,omitempty"`
	Limit   *int64           `json:"limit,omitempty"`
	Results []*Configuration `json:"results"`
	Total   int64            `json:"total,omitempty"`
}

ConfigurationList represents an NS1 redirect configuration list object

type ForwardingMode

type ForwardingMode string

ForwardingMode is a string enum

const (
	All     ForwardingMode = "all"
	Capture ForwardingMode = "capture"
	None    ForwardingMode = "none"
)

func ParseForwardingMode

func ParseForwardingMode(str string) (ForwardingMode, bool)

func (ForwardingMode) String

func (s ForwardingMode) String() string

type ForwardingType

type ForwardingType string

ForwardingType is a string enum

const (
	Masking   ForwardingType = "masking"
	Permanent ForwardingType = "permanent"
	Temporary ForwardingType = "temporary"
)

func ParseForwardingType

func ParseForwardingType(str string) (ForwardingType, bool)

func (ForwardingType) String

func (s ForwardingType) String() string