lb

package
v1.0.0-beta.6 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2020 License: Apache-2.0 Imports: 13 Imported by: 11

Documentation

Overview

Package lb provides methods and message types of the lb v1 API.

Index

Constants

View Source 
const (
	// ACLActionTypeAllow is [insert doc].
	ACLActionTypeAllow = ACLActionType("allow")
	// ACLActionTypeDeny is [insert doc].
	ACLActionTypeDeny = ACLActionType("deny")
)
View Source 
const (
	// ACLHTTPFilterACLHTTPFilterNone is [insert doc].
	ACLHTTPFilterACLHTTPFilterNone = ACLHTTPFilter("acl_http_filter_none")
	// ACLHTTPFilterPathBegin is [insert doc].
	ACLHTTPFilterPathBegin = ACLHTTPFilter("path_begin")
	// ACLHTTPFilterPathEnd is [insert doc].
	ACLHTTPFilterPathEnd = ACLHTTPFilter("path_end")
	// ACLHTTPFilterRegex is [insert doc].
	ACLHTTPFilterRegex = ACLHTTPFilter("regex")
)
View Source 
const (
	// BackendServerStatsHealthCheckStatusUnknown is [insert doc].
	BackendServerStatsHealthCheckStatusUnknown = BackendServerStatsHealthCheckStatus("unknown")
	// BackendServerStatsHealthCheckStatusNeutral is [insert doc].
	BackendServerStatsHealthCheckStatusNeutral = BackendServerStatsHealthCheckStatus("neutral")
	// BackendServerStatsHealthCheckStatusFailed is [insert doc].
	BackendServerStatsHealthCheckStatusFailed = BackendServerStatsHealthCheckStatus("failed")
	// BackendServerStatsHealthCheckStatusPassed is [insert doc].
	BackendServerStatsHealthCheckStatusPassed = BackendServerStatsHealthCheckStatus("passed")
	// BackendServerStatsHealthCheckStatusCondpass is [insert doc].
	BackendServerStatsHealthCheckStatusCondpass = BackendServerStatsHealthCheckStatus("condpass")
)
View Source 
const (
	// BackendServerStatsServerStateStopped is [insert doc].
	BackendServerStatsServerStateStopped = BackendServerStatsServerState("stopped")
	// BackendServerStatsServerStateStarting is [insert doc].
	BackendServerStatsServerStateStarting = BackendServerStatsServerState("starting")
	// BackendServerStatsServerStateRunning is [insert doc].
	BackendServerStatsServerStateRunning = BackendServerStatsServerState("running")
	// BackendServerStatsServerStateStopping is [insert doc].
	BackendServerStatsServerStateStopping = BackendServerStatsServerState("stopping")
)
View Source 
const (
	// CertificateStatusPending is [insert doc].
	CertificateStatusPending = CertificateStatus("pending")
	// CertificateStatusReady is [insert doc].
	CertificateStatusReady = CertificateStatus("ready")
	// CertificateStatusError is [insert doc].
	CertificateStatusError = CertificateStatus("error")
)
View Source 
const (
	// CertificateTypeLetsencryt is [insert doc].
	CertificateTypeLetsencryt = CertificateType("letsencryt")
	// CertificateTypeCustom is [insert doc].
	CertificateTypeCustom = CertificateType("custom")
)
View Source 
const (
	// ForwardPortAlgorithmRoundrobin is [insert doc].
	ForwardPortAlgorithmRoundrobin = ForwardPortAlgorithm("roundrobin")
	// ForwardPortAlgorithmLeastconn is [insert doc].
	ForwardPortAlgorithmLeastconn = ForwardPortAlgorithm("leastconn")
)
View Source 
const (
	// InstanceStatusUnknown is [insert doc].
	InstanceStatusUnknown = InstanceStatus("unknown")
	// InstanceStatusReady is [insert doc].
	InstanceStatusReady = InstanceStatus("ready")
	// InstanceStatusPending is [insert doc].
	InstanceStatusPending = InstanceStatus("pending")
	// InstanceStatusStopped is [insert doc].
	InstanceStatusStopped = InstanceStatus("stopped")
	// InstanceStatusError is [insert doc].
	InstanceStatusError = InstanceStatus("error")
	// InstanceStatusLocked is [insert doc].
	InstanceStatusLocked = InstanceStatus("locked")
	// InstanceStatusMigrating is [insert doc].
	InstanceStatusMigrating = InstanceStatus("migrating")
)
View Source 
const (
	// LbStatusUnknown is [insert doc].
	LbStatusUnknown = LbStatus("unknown")
	// LbStatusReady is [insert doc].
	LbStatusReady = LbStatus("ready")
	// LbStatusPending is [insert doc].
	LbStatusPending = LbStatus("pending")
	// LbStatusStopped is [insert doc].
	LbStatusStopped = LbStatus("stopped")
	// LbStatusError is [insert doc].
	LbStatusError = LbStatus("error")
	// LbStatusLocked is [insert doc].
	LbStatusLocked = LbStatus("locked")
	// LbStatusMigrating is [insert doc].
	LbStatusMigrating = LbStatus("migrating")
)
View Source 
const (
	// LbTypeStockUnknown is [insert doc].
	LbTypeStockUnknown = LbTypeStock("unknown")
	// LbTypeStockLowStock is [insert doc].
	LbTypeStockLowStock = LbTypeStock("low_stock")
	// LbTypeStockOutOfStock is [insert doc].
	LbTypeStockOutOfStock = LbTypeStock("out_of_stock")
	// LbTypeStockAvailable is [insert doc].
	LbTypeStockAvailable = LbTypeStock("available")
)
View Source 
const (
	// ListACLRequestOrderByCreatedAtAsc is [insert doc].
	ListACLRequestOrderByCreatedAtAsc = ListACLRequestOrderBy("created_at_asc")
	// ListACLRequestOrderByCreatedAtDesc is [insert doc].
	ListACLRequestOrderByCreatedAtDesc = ListACLRequestOrderBy("created_at_desc")
	// ListACLRequestOrderByNameAsc is [insert doc].
	ListACLRequestOrderByNameAsc = ListACLRequestOrderBy("name_asc")
	// ListACLRequestOrderByNameDesc is [insert doc].
	ListACLRequestOrderByNameDesc = ListACLRequestOrderBy("name_desc")
)
View Source 
const (
	// ListBackendsRequestOrderByCreatedAtAsc is [insert doc].
	ListBackendsRequestOrderByCreatedAtAsc = ListBackendsRequestOrderBy("created_at_asc")
	// ListBackendsRequestOrderByCreatedAtDesc is [insert doc].
	ListBackendsRequestOrderByCreatedAtDesc = ListBackendsRequestOrderBy("created_at_desc")
	// ListBackendsRequestOrderByNameAsc is [insert doc].
	ListBackendsRequestOrderByNameAsc = ListBackendsRequestOrderBy("name_asc")
	// ListBackendsRequestOrderByNameDesc is [insert doc].
	ListBackendsRequestOrderByNameDesc = ListBackendsRequestOrderBy("name_desc")
)
View Source 
const (
	// ListCertificatesRequestOrderByCreatedAtAsc is [insert doc].
	ListCertificatesRequestOrderByCreatedAtAsc = ListCertificatesRequestOrderBy("created_at_asc")
	// ListCertificatesRequestOrderByCreatedAtDesc is [insert doc].
	ListCertificatesRequestOrderByCreatedAtDesc = ListCertificatesRequestOrderBy("created_at_desc")
	// ListCertificatesRequestOrderByNameAsc is [insert doc].
	ListCertificatesRequestOrderByNameAsc = ListCertificatesRequestOrderBy("name_asc")
	// ListCertificatesRequestOrderByNameDesc is [insert doc].
	ListCertificatesRequestOrderByNameDesc = ListCertificatesRequestOrderBy("name_desc")
)
View Source 
const (
	// ListFrontendsRequestOrderByCreatedAtAsc is [insert doc].
	ListFrontendsRequestOrderByCreatedAtAsc = ListFrontendsRequestOrderBy("created_at_asc")
	// ListFrontendsRequestOrderByCreatedAtDesc is [insert doc].
	ListFrontendsRequestOrderByCreatedAtDesc = ListFrontendsRequestOrderBy("created_at_desc")
	// ListFrontendsRequestOrderByNameAsc is [insert doc].
	ListFrontendsRequestOrderByNameAsc = ListFrontendsRequestOrderBy("name_asc")
	// ListFrontendsRequestOrderByNameDesc is [insert doc].
	ListFrontendsRequestOrderByNameDesc = ListFrontendsRequestOrderBy("name_desc")
)
View Source 
const (
	// ListLbsRequestOrderByCreatedAtAsc is [insert doc].
	ListLbsRequestOrderByCreatedAtAsc = ListLbsRequestOrderBy("created_at_asc")
	// ListLbsRequestOrderByCreatedAtDesc is [insert doc].
	ListLbsRequestOrderByCreatedAtDesc = ListLbsRequestOrderBy("created_at_desc")
	// ListLbsRequestOrderByNameAsc is [insert doc].
	ListLbsRequestOrderByNameAsc = ListLbsRequestOrderBy("name_asc")
	// ListLbsRequestOrderByNameDesc is [insert doc].
	ListLbsRequestOrderByNameDesc = ListLbsRequestOrderBy("name_desc")
)
View Source 
const (
	// ListSubscriberRequestOrderByCreatedAtAsc is [insert doc].
	ListSubscriberRequestOrderByCreatedAtAsc = ListSubscriberRequestOrderBy("created_at_asc")
	// ListSubscriberRequestOrderByCreatedAtDesc is [insert doc].
	ListSubscriberRequestOrderByCreatedAtDesc = ListSubscriberRequestOrderBy("created_at_desc")
	// ListSubscriberRequestOrderByNameAsc is [insert doc].
	ListSubscriberRequestOrderByNameAsc = ListSubscriberRequestOrderBy("name_asc")
	// ListSubscriberRequestOrderByNameDesc is [insert doc].
	ListSubscriberRequestOrderByNameDesc = ListSubscriberRequestOrderBy("name_desc")
)
View Source 
const (
	// OnMarkedDownActionOnMarkedDownActionNone is [insert doc].
	OnMarkedDownActionOnMarkedDownActionNone = OnMarkedDownAction("on_marked_down_action_none")
	// OnMarkedDownActionShutdownSessions is [insert doc].
	OnMarkedDownActionShutdownSessions = OnMarkedDownAction("shutdown_sessions")
)
View Source 
const (
	// ProtocolTCP is [insert doc].
	ProtocolTCP = Protocol("tcp")
	// ProtocolHTTP is [insert doc].
	ProtocolHTTP = Protocol("http")
)
View Source 
const (
	// ProxyProtocolProxyProtocolUnknown is [insert doc].
	ProxyProtocolProxyProtocolUnknown = ProxyProtocol("proxy_protocol_unknown")
	// ProxyProtocolProxyProtocolNone is [insert doc].
	ProxyProtocolProxyProtocolNone = ProxyProtocol("proxy_protocol_none")
	// ProxyProtocolProxyProtocolV1 is [insert doc].
	ProxyProtocolProxyProtocolV1 = ProxyProtocol("proxy_protocol_v1")
	// ProxyProtocolProxyProtocolV2 is [insert doc].
	ProxyProtocolProxyProtocolV2 = ProxyProtocol("proxy_protocol_v2")
	// ProxyProtocolProxyProtocolV2Ssl is [insert doc].
	ProxyProtocolProxyProtocolV2Ssl = ProxyProtocol("proxy_protocol_v2_ssl")
	// ProxyProtocolProxyProtocolV2SslCn is [insert doc].
	ProxyProtocolProxyProtocolV2SslCn = ProxyProtocol("proxy_protocol_v2_ssl_cn")
)
View Source 
const (
	// StickySessionsTypeNone is [insert doc].
	StickySessionsTypeNone = StickySessionsType("none")
	// StickySessionsTypeCookie is [insert doc].
	StickySessionsTypeCookie = StickySessionsType("cookie")
	// StickySessionsTypeTable is [insert doc].
	StickySessionsTypeTable = StickySessionsType("table")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ACL 

type ACL struct {
	// ID iD of your ACL ressource
	ID string `json:"id"`
	// Name name of you ACL ressource
	Name string `json:"name"`
	// Match see the AclMatch object description
	Match *ACLMatch `json:"match"`
	// Action see the AclAction object description
	Action *ACLAction `json:"action"`
	// Frontend see the Frontend object description
	Frontend *Frontend `json:"frontend"`
	// Index order between your Acls (ascending order, 0 is first acl executed)
	Index int32 `json:"index"`
}

ACL the use of Access Control Lists (ACL) provide a flexible solution to perform a action generally consist in blocking or allow a request based on ip (and URL on HTTP)

type ACLAction 

type ACLAction struct {
	// Type <allow> or <deny> request
	//
	// Default value: allow
	Type ACLActionType `json:"type"`
}

ACLAction action if your ACL filter match

type ACLActionType 

type ACLActionType string

func (ACLActionType) MarshalJSON 

func (enum ACLActionType) MarshalJSON() ([]byte, error)

func (ACLActionType) String 

func (enum ACLActionType) String() string

func (*ACLActionType) UnmarshalJSON 

func (enum *ACLActionType) UnmarshalJSON(data []byte) error

type ACLHTTPFilter 

type ACLHTTPFilter string

func (ACLHTTPFilter) MarshalJSON 

func (enum ACLHTTPFilter) MarshalJSON() ([]byte, error)

func (ACLHTTPFilter) String 

func (enum ACLHTTPFilter) String() string

func (*ACLHTTPFilter) UnmarshalJSON 

func (enum *ACLHTTPFilter) UnmarshalJSON(data []byte) error

type ACLMatch 

type ACLMatch struct {
	// IPSubnet this is the source IP v4/v6 address of the client of the session to match or not. Addresses values can be specified either as plain addresses or with a netmask appended
	IPSubnet []*string `json:"ip_subnet"`
	// HTTPFilter you can set http filter (if your backend protocole have a http forward protocol. This extracts the request's URL path, which starts at the first slash and ends before the question mark (without the host part). You can choose between <path_begin> prefix match (like /admin), <path_end> suffix match (like .php) and <regex>
	//
	// Default value: acl_http_filter_none
	HTTPFilter ACLHTTPFilter `json:"http_filter"`

	HTTPFilterValue []*string `json:"http_filter_value"`
	// Invert by default match filter is a IF condition. You can set invert to true to have a unless condition
	Invert bool `json:"invert"`
}

ACLMatch settings of your ACL filter

type API 

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

API this API allows you to manage your Load Balancer service

func NewAPI 

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

func (*API) AddBackendServers 

func (s *API) AddBackendServers(req *AddBackendServersRequest, opts ...scw.RequestOption) (*Backend, error)

func (*API) CreateACL 

func (s *API) CreateACL(req *CreateACLRequest, opts ...scw.RequestOption) (*ACL, error)

func (*API) CreateBackend 

func (s *API) CreateBackend(req *CreateBackendRequest, opts ...scw.RequestOption) (*Backend, error)

func (*API) CreateCertificate 

func (s *API) CreateCertificate(req *CreateCertificateRequest, opts ...scw.RequestOption) (*Certificate, error)

CreateCertificate create Certificate

Generate a new SSL certificate using Let's Encrypt or import your certificate.

func (*API) CreateFrontend 

func (s *API) CreateFrontend(req *CreateFrontendRequest, opts ...scw.RequestOption) (*Frontend, error)

func (*API) CreateIP 

func (s *API) CreateIP(req *CreateIPRequest, opts ...scw.RequestOption) (*IP, error)

CreateIP create IP

func (*API) CreateLb 

func (s *API) CreateLb(req *CreateLbRequest, opts ...scw.RequestOption) (*Lb, error)

func (*API) CreateSubscriber 

func (s *API) CreateSubscriber(req *CreateSubscriberRequest, opts ...scw.RequestOption) (*Subscriber, error)

CreateSubscriber create a subscriber, webhook or email

func (*API) DeleteACL 

func (s *API) DeleteACL(req *DeleteACLRequest, opts ...scw.RequestOption) error

func (*API) DeleteBackend 

func (s *API) DeleteBackend(req *DeleteBackendRequest, opts ...scw.RequestOption) error

func (*API) DeleteCertificate 

func (s *API) DeleteCertificate(req *DeleteCertificateRequest, opts ...scw.RequestOption) error

DeleteCertificate delete Certificate

func (*API) DeleteFrontend 

func (s *API) DeleteFrontend(req *DeleteFrontendRequest, opts ...scw.RequestOption) error

func (*API) DeleteLb 

func (s *API) DeleteLb(req *DeleteLbRequest, opts ...scw.RequestOption) error

func (*API) DeleteSubscriber 

func (s *API) DeleteSubscriber(req *DeleteSubscriberRequest, opts ...scw.RequestOption) error

DeleteSubscriber delete a subscriber

func (*API) GetACL 

func (s *API) GetACL(req *GetACLRequest, opts ...scw.RequestOption) (*ACL, error)

func (*API) GetBackend 

func (s *API) GetBackend(req *GetBackendRequest, opts ...scw.RequestOption) (*Backend, error)

func (*API) GetCertificate 

func (s *API) GetCertificate(req *GetCertificateRequest, opts ...scw.RequestOption) (*Certificate, error)

GetCertificate get Certificate

func (*API) GetFrontend 

func (s *API) GetFrontend(req *GetFrontendRequest, opts ...scw.RequestOption) (*Frontend, error)

func (*API) GetIP 

func (s *API) GetIP(req *GetIPRequest, opts ...scw.RequestOption) (*IP, error)

GetIP get IP

func (*API) GetLb 

func (s *API) GetLb(req *GetLbRequest, opts ...scw.RequestOption) (*Lb, error)

func (*API) GetLbStats 

func (s *API) GetLbStats(req *GetLbStatsRequest, opts ...scw.RequestOption) (*LbStats, error)

func (*API) GetServiceInfo 

func (s *API) GetServiceInfo(req *GetServiceInfoRequest, opts ...scw.RequestOption) (*scw.ServiceInfo, error)

func (*API) GetSubscriber 

func (s *API) GetSubscriber(req *GetSubscriberRequest, opts ...scw.RequestOption) (*Subscriber, error)

GetSubscriber get a subscriber

func (*API) ListACLs 

func (s *API) ListACLs(req *ListACLsRequest, opts ...scw.RequestOption) (*ListACLResponse, error)

func (*API) ListBackendStats 

func (s *API) ListBackendStats(req *ListBackendStatsRequest, opts ...scw.RequestOption) (*ListBackendStatsResponse, error)

func (*API) ListBackends 

func (s *API) ListBackends(req *ListBackendsRequest, opts ...scw.RequestOption) (*ListBackendsResponse, error)

func (*API) ListCertificates 

func (s *API) ListCertificates(req *ListCertificatesRequest, opts ...scw.RequestOption) (*ListCertificatesResponse, error)

ListCertificates list Certificates

func (*API) ListFrontends 

func (s *API) ListFrontends(req *ListFrontendsRequest, opts ...scw.RequestOption) (*ListFrontendsResponse, error)

func (*API) ListIPs 

func (s *API) ListIPs(req *ListIPsRequest, opts ...scw.RequestOption) (*ListIPsResponse, error)

ListIPs list IPs

func (*API) ListLbTypes 

func (s *API) ListLbTypes(req *ListLbTypesRequest, opts ...scw.RequestOption) (*ListLbTypesResponse, error)

ListLbTypes list all Load Balancer offer type

func (*API) ListLbs 

func (s *API) ListLbs(req *ListLbsRequest, opts ...scw.RequestOption) (*ListLbsResponse, error)

func (*API) ListSubscriber 

func (s *API) ListSubscriber(req *ListSubscriberRequest, opts ...scw.RequestOption) (*ListSubscriberResponse, error)

ListSubscriber list all subscriber

func (*API) ReleaseIP 

func (s *API) ReleaseIP(req *ReleaseIPRequest, opts ...scw.RequestOption) error

ReleaseIP release IP

func (*API) RemoveBackendServers 

func (s *API) RemoveBackendServers(req *RemoveBackendServersRequest, opts ...scw.RequestOption) (*Backend, error)

func (*API) SetBackendServers 

func (s *API) SetBackendServers(req *SetBackendServersRequest, opts ...scw.RequestOption) (*Backend, error)

func (*API) SubscribeToLb 

func (s *API) SubscribeToLb(req *SubscribeToLbRequest, opts ...scw.RequestOption) (*Lb, error)

SubscribeToLb link Load Balancer to a subscriber

func (*API) UnsubscribeFromLb 

func (s *API) UnsubscribeFromLb(req *UnsubscribeFromLbRequest, opts ...scw.RequestOption) (*Lb, error)

UnsubscribeFromLb remove link between Load Balancer and subscriber

func (*API) UpdateACL 

func (s *API) UpdateACL(req *UpdateACLRequest, opts ...scw.RequestOption) (*ACL, error)

func (*API) UpdateBackend 

func (s *API) UpdateBackend(req *UpdateBackendRequest, opts ...scw.RequestOption) (*Backend, error)

func (*API) UpdateCertificate 

func (s *API) UpdateCertificate(req *UpdateCertificateRequest, opts ...scw.RequestOption) (*Certificate, error)

UpdateCertificate update Certificate

func (*API) UpdateFrontend 

func (s *API) UpdateFrontend(req *UpdateFrontendRequest, opts ...scw.RequestOption) (*Frontend, error)

func (*API) UpdateHealthCheck 

func (s *API) UpdateHealthCheck(req *UpdateHealthCheckRequest, opts ...scw.RequestOption) (*HealthCheck, error)

func (*API) UpdateIP 

func (s *API) UpdateIP(req *UpdateIPRequest, opts ...scw.RequestOption) (*IP, error)

UpdateIP update IP

func (*API) UpdateLb 

func (s *API) UpdateLb(req *UpdateLbRequest, opts ...scw.RequestOption) (*Lb, error)

func (*API) UpdateSubscriber 

func (s *API) UpdateSubscriber(req *UpdateSubscriberRequest, opts ...scw.RequestOption) (*Subscriber, error)

UpdateSubscriber update a subscriber

func (*API) WaitForLb 

func (s *API) WaitForLb(req *WaitForLbRequest) (*Lb, error)

WaitForLb waits for the lb to be in a "terminal state" before returning. This function can be used to wait for a lb to be ready for example.

type AddBackendServersRequest 

type AddBackendServersRequest struct {
	Region scw.Region `json:"-"`
	// BackendID backend ID
	BackendID string `json:"-"`
	// ServerIP set all IPs to add on your backend
	ServerIP []string `json:"server_ip"`
}

type Backend 

type Backend struct {
	ID string `json:"id"`

	Name string `json:"name"`
	// ForwardProtocol
	//
	// Default value: tcp
	ForwardProtocol Protocol `json:"forward_protocol"`

	ForwardPort int32 `json:"forward_port"`
	// ForwardPortAlgorithm
	//
	// Default value: roundrobin
	ForwardPortAlgorithm ForwardPortAlgorithm `json:"forward_port_algorithm"`
	// StickySessions
	//
	// Default value: none
	StickySessions StickySessionsType `json:"sticky_sessions"`

	StickySessionsCookieName string `json:"sticky_sessions_cookie_name"`

	HealthCheck *HealthCheck `json:"health_check"`

	Pool []string `json:"pool"`

	Lb *Lb `json:"lb"`

	SendProxyV2 bool `json:"send_proxy_v2"`

	TimeoutServer *time.Duration `json:"timeout_server"`

	TimeoutConnect *time.Duration `json:"timeout_connect"`

	TimeoutTunnel *time.Duration `json:"timeout_tunnel"`
	// OnMarkedDownAction
	//
	// Default value: on_marked_down_action_none
	OnMarkedDownAction OnMarkedDownAction `json:"on_marked_down_action"`
	// ProxyProtocol
	//
	// Default value: proxy_protocol_unknown
	ProxyProtocol ProxyProtocol `json:"proxy_protocol"`
}

Backend backend

func (Backend) MarshalJSON 

func (m Backend) MarshalJSON() ([]byte, error)

func (*Backend) UnmarshalJSON 

func (m *Backend) UnmarshalJSON(b []byte) error

type BackendServerStats 

type BackendServerStats struct {
	// InstanceID iD of your loadbalancer cluster server
	InstanceID string `json:"instance_id"`
	// BackendID iD of your Backend
	BackendID string `json:"backend_id"`
	// IP iPv4 or IPv6 address of the server backend
	IP string `json:"ip"`
	// ServerState server operational state (stopped/starting/running/stopping)
	//
	// Default value: stopped
	ServerState BackendServerStatsServerState `json:"server_state"`
	// ServerStateChangedAt time since last operational change
	ServerStateChangedAt time.Time `json:"server_state_changed_at"`
	// LastHealthCheckStatus last health check status (unknown/neutral/failed/passed/condpass)
	//
	// Default value: unknown
	LastHealthCheckStatus BackendServerStatsHealthCheckStatus `json:"last_health_check_status"`
}

BackendServerStats state and statistics of your backend server like last healthcheck status, server uptime, result state of your backend server

type BackendServerStatsHealthCheckStatus 

type BackendServerStatsHealthCheckStatus string

func (BackendServerStatsHealthCheckStatus) MarshalJSON 

func (enum BackendServerStatsHealthCheckStatus) MarshalJSON() ([]byte, error)

func (BackendServerStatsHealthCheckStatus) String 

func (enum BackendServerStatsHealthCheckStatus) String() string

func (*BackendServerStatsHealthCheckStatus) UnmarshalJSON 

func (enum *BackendServerStatsHealthCheckStatus) UnmarshalJSON(data []byte) error

type BackendServerStatsServerState 

type BackendServerStatsServerState string

func (BackendServerStatsServerState) MarshalJSON 

func (enum BackendServerStatsServerState) MarshalJSON() ([]byte, error)

func (BackendServerStatsServerState) String 

func (enum BackendServerStatsServerState) String() string

func (*BackendServerStatsServerState) UnmarshalJSON 

func (enum *BackendServerStatsServerState) UnmarshalJSON(data []byte) error

type Certificate 

type Certificate struct {
	// Type type of certificate (Let's encrypt or custom)
	//
	// Default value: letsencryt
	Type CertificateType `json:"type"`
	// ID certificate ID
	ID string `json:"id"`
	// CommonName main domain name of certificate
	CommonName string `json:"common_name"`
	// SubjectAlternativeName alternative domain names
	SubjectAlternativeName []string `json:"subject_alternative_name"`
	// Fingerprint identifier (SHA-1) of the certificate
	Fingerprint string `json:"fingerprint"`
	// NotValidBefore validity bounds
	NotValidBefore time.Time `json:"not_valid_before"`
	// NotValidAfter validity bounds
	NotValidAfter time.Time `json:"not_valid_after"`
	// Status status of certificate
	//
	// Default value: pending
	Status CertificateStatus `json:"status"`
	// Lb load Balancer object
	Lb *Lb `json:"lb"`
	// Name certificate name
	Name string `json:"name"`
}

Certificate sSL certificate

type CertificateStatus 

type CertificateStatus string

func (CertificateStatus) MarshalJSON 

func (enum CertificateStatus) MarshalJSON() ([]byte, error)

func (CertificateStatus) String 

func (enum CertificateStatus) String() string

func (*CertificateStatus) UnmarshalJSON 

func (enum *CertificateStatus) UnmarshalJSON(data []byte) error

type CertificateType 

type CertificateType string

func (CertificateType) MarshalJSON 

func (enum CertificateType) MarshalJSON() ([]byte, error)

func (CertificateType) String 

func (enum CertificateType) String() string

func (*CertificateType) UnmarshalJSON 

func (enum *CertificateType) UnmarshalJSON(data []byte) error

type CreateACLRequest 

type CreateACLRequest struct {
	Region scw.Region `json:"-"`
	// FrontendID iD of your frontend
	FrontendID string `json:"-"`
	// Name name of your ACL ressource
	Name string `json:"name"`
	// Action see the AclAction object description
	Action *ACLAction `json:"action"`
	// Match see the AclMatch object description
	Match *ACLMatch `json:"match"`
	// Index order between your Acls (ascending order, 0 is first acl executed)
	Index int32 `json:"index"`
}

type CreateBackendRequest 

type CreateBackendRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// Name resource name
	Name string `json:"name"`
	// ForwardProtocol backend protocol. TCP or HTTP
	//
	// Default value: tcp
	ForwardProtocol Protocol `json:"forward_protocol"`
	// ForwardPort user sessions will be forwarded to this port of backend servers
	ForwardPort int32 `json:"forward_port"`
	// ForwardPortAlgorithm load balancing algorithm
	//
	// Default value: roundrobin
	ForwardPortAlgorithm ForwardPortAlgorithm `json:"forward_port_algorithm"`
	// StickySessions enables cookie-based session persistence
	//
	// Default value: none
	StickySessions StickySessionsType `json:"sticky_sessions"`
	// StickySessionsCookieName cookie name for for sticky sessions
	StickySessionsCookieName string `json:"sticky_sessions_cookie_name"`
	// HealthCheck see the Healthcheck object description
	HealthCheck *HealthCheck `json:"health_check"`
	// ServerIP backend server IP addresses list (IPv4 or IPv6)
	ServerIP []string `json:"server_ip"`
	// SendProxyV2 deprecated in favor of proxy_protocol field !
	SendProxyV2 bool `json:"send_proxy_v2"`
	// TimeoutServer maximum server connection inactivity time
	TimeoutServer *time.Duration `json:"timeout_server"`
	// TimeoutConnect maximum initical server connection establishment time
	TimeoutConnect *time.Duration `json:"timeout_connect"`
	// TimeoutTunnel maximum tunnel inactivity time
	TimeoutTunnel *time.Duration `json:"timeout_tunnel"`
	// OnMarkedDownAction modify what occurs when a backend server is marked down
	//
	// Default value: on_marked_down_action_none
	OnMarkedDownAction OnMarkedDownAction `json:"on_marked_down_action"`
	// ProxyProtocol pROXY protocol, forward client's address (must be supported by backend servers software)
	//
	// The PROXY protocol informs the other end about the incoming connection, so that it can know the client's address or the public address it accessed to, whatever the upper layer protocol.
	//
	// * `proxy_protocol_none` Disable proxy protocol.
	// * `proxy_protocol_v1` Version one (text format).
	// * `proxy_protocol_v2` Version two (binary format).
	// * `proxy_protocol_v2_ssl` Version two with SSL connection.
	// * `proxy_protocol_v2_ssl_cn` Version two with SSL connection and common name information.
	//
	// Default value: proxy_protocol_unknown
	ProxyProtocol ProxyProtocol `json:"proxy_protocol"`
}

func (CreateBackendRequest) MarshalJSON 

func (m CreateBackendRequest) MarshalJSON() ([]byte, error)

func (*CreateBackendRequest) UnmarshalJSON 

func (m *CreateBackendRequest) UnmarshalJSON(b []byte) error

type CreateCertificateRequest 

type CreateCertificateRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// Name certificate name
	Name string `json:"name"`
	// Letsencrypt let's Encrypt type
	// Precisely one of CustomCertificate, Letsencrypt must be set.
	Letsencrypt *CreateCertificateRequestLetsencryptConfig `json:"letsencrypt,omitempty"`
	// CustomCertificate custom import certificate
	// Precisely one of CustomCertificate, Letsencrypt must be set.
	CustomCertificate *CreateCertificateRequestCustomCertificate `json:"custom_certificate,omitempty"`
}

type CreateCertificateRequestCustomCertificate 

type CreateCertificateRequestCustomCertificate struct {
	// CertificateChain the full PEM-formatted include an entire certificate chain including public key, private key, and optionally certificate authorities.
	CertificateChain string `json:"certificate_chain"`
}

CreateCertificateRequestCustomCertificate import a custom SSL certificate

type CreateCertificateRequestLetsencryptConfig 

type CreateCertificateRequestLetsencryptConfig struct {
	// CommonName main domain name of certificate (make sure this domain exists and resolves to your Load Balancer HA IP)
	CommonName string `json:"common_name"`
	// SubjectAlternativeName alternative domain names (make sure all domain names exists and resolves to your Load Balancer HA IP)
	SubjectAlternativeName []string `json:"subject_alternative_name"`
}

CreateCertificateRequestLetsencryptConfig generate a new SSL certificate using Let's Encrypt.

type CreateFrontendRequest 

type CreateFrontendRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// Name resource name
	Name string `json:"name"`
	// InboundPort tCP port to listen on the front side
	InboundPort int32 `json:"inbound_port"`
	// BackendID backend ID
	BackendID string `json:"backend_id"`
	// TimeoutClient set the maximum inactivity time on the client side
	TimeoutClient *time.Duration `json:"timeout_client"`
	// CertificateID certificate ID
	CertificateID *string `json:"certificate_id"`
}

func (CreateFrontendRequest) MarshalJSON 

func (m CreateFrontendRequest) MarshalJSON() ([]byte, error)

func (*CreateFrontendRequest) UnmarshalJSON 

func (m *CreateFrontendRequest) UnmarshalJSON(b []byte) error

type CreateIPRequest 

type CreateIPRequest struct {
	Region scw.Region `json:"-"`
	// OrganizationID owner of resources
	OrganizationID string `json:"organization_id"`
	// Reverse reverse domain name
	Reverse *string `json:"reverse"`
}

type CreateLbRequest 

type CreateLbRequest struct {
	Region scw.Region `json:"-"`
	// OrganizationID owner of resources
	OrganizationID string `json:"organization_id"`
	// Name resource names
	Name string `json:"name"`
	// Description resource description
	Description string `json:"description"`
	// IPID just like for compute instances, when you destroy a Load Balancer, you can keep its highly available IP address and reuse it for another Load Balancer later
	IPID *string `json:"ip_id"`
	// Tags list of keyword
	Tags []string `json:"tags"`
	// Type load Balancer offer type
	Type string `json:"type"`
}

type CreateSubscriberRequest 

type CreateSubscriberRequest struct {
	Region scw.Region `json:"-"`
	// Name subscriber name
	Name string `json:"name"`
	// EmailConfig email address configuration
	// Precisely one of EmailConfig, WebhookConfig must be set.
	EmailConfig *SubscriberEmailConfig `json:"email_config,omitempty"`
	// WebhookConfig webHook URI configuration
	// Precisely one of EmailConfig, WebhookConfig must be set.
	WebhookConfig *SubscriberWebhookConfig `json:"webhook_config,omitempty"`
	// OrganizationID owner of resources
	OrganizationID string `json:"organization_id"`
}

type DeleteACLRequest 

type DeleteACLRequest struct {
	Region scw.Region `json:"-"`
	// ACLID iD of your ACL ressource
	ACLID string `json:"-"`
}

type DeleteBackendRequest 

type DeleteBackendRequest struct {
	Region scw.Region `json:"-"`
	// BackendID iD of the backend to delete
	BackendID string `json:"-"`
}

type DeleteCertificateRequest 

type DeleteCertificateRequest struct {
	Region scw.Region `json:"-"`
	// CertificateID certificate ID
	CertificateID string `json:"-"`
}

type DeleteFrontendRequest 

type DeleteFrontendRequest struct {
	Region scw.Region `json:"-"`
	// FrontendID frontend ID to delete
	FrontendID string `json:"-"`
}

type DeleteLbRequest 

type DeleteLbRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// ReleaseIP set true if you don't want to keep this IP address
	ReleaseIP bool `json:"-"`
}

type DeleteSubscriberRequest 

type DeleteSubscriberRequest struct {
	Region scw.Region `json:"-"`
	// SubscriberID subscriber ID
	SubscriberID string `json:"-"`
}

type ForwardPortAlgorithm 

type ForwardPortAlgorithm string

func (ForwardPortAlgorithm) MarshalJSON 

func (enum ForwardPortAlgorithm) MarshalJSON() ([]byte, error)

func (ForwardPortAlgorithm) String 

func (enum ForwardPortAlgorithm) String() string

func (*ForwardPortAlgorithm) UnmarshalJSON 

func (enum *ForwardPortAlgorithm) UnmarshalJSON(data []byte) error

type Frontend 

type Frontend struct {
	ID string `json:"id"`

	Name string `json:"name"`

	InboundPort int32 `json:"inbound_port"`

	Backend *Backend `json:"backend"`

	Lb *Lb `json:"lb"`

	TimeoutClient *time.Duration `json:"timeout_client"`

	Certificate *Certificate `json:"certificate"`
}

Frontend frontend

func (Frontend) MarshalJSON 

func (m Frontend) MarshalJSON() ([]byte, error)

func (*Frontend) UnmarshalJSON 

func (m *Frontend) UnmarshalJSON(b []byte) error

type GetACLRequest 

type GetACLRequest struct {
	Region scw.Region `json:"-"`
	// ACLID iD of your ACL ressource
	ACLID string `json:"-"`
}

type GetBackendRequest 

type GetBackendRequest struct {
	Region scw.Region `json:"-"`
	// BackendID backend ID
	BackendID string `json:"-"`
}

type GetCertificateRequest 

type GetCertificateRequest struct {
	Region scw.Region `json:"-"`
	// CertificateID certificate ID
	CertificateID string `json:"-"`
}

type GetFrontendRequest 

type GetFrontendRequest struct {
	Region scw.Region `json:"-"`
	// FrontendID frontend ID
	FrontendID string `json:"-"`
}

type GetIPRequest 

type GetIPRequest struct {
	Region scw.Region `json:"-"`
	// IPID iP address ID
	IPID string `json:"-"`
}

type GetLbRequest 

type GetLbRequest struct {
	Region scw.Region `json:"-"`

	LbID string `json:"-"`
}

type GetLbStatsRequest 

type GetLbStatsRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
}

type GetServiceInfoRequest 

type GetServiceInfoRequest struct {
	Region scw.Region `json:"-"`
}

type GetSubscriberRequest 

type GetSubscriberRequest struct {
	Region scw.Region `json:"-"`
	// SubscriberID subscriber ID
	SubscriberID string `json:"-"`
}

type HealthCheck 

type HealthCheck struct {
	// MysqlConfig the check requires MySQL >=3.22, for older versions, use TCP check
	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	MysqlConfig *HealthCheckMysqlConfig `json:"mysql_config,omitempty"`
	// LdapConfig the response is analyzed to find an LDAPv3 response message
	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	LdapConfig *HealthCheckLdapConfig `json:"ldap_config,omitempty"`
	// RedisConfig the response is analyzed to find the +PONG response message
	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	RedisConfig *HealthCheckRedisConfig `json:"redis_config,omitempty"`

	CheckMaxRetries int32 `json:"check_max_retries"`

	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	TCPConfig *HealthCheckTCPConfig `json:"tcp_config,omitempty"`

	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	PgsqlConfig *HealthCheckPgsqlConfig `json:"pgsql_config,omitempty"`

	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	HTTPConfig *HealthCheckHTTPConfig `json:"http_config,omitempty"`

	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	HTTPSConfig *HealthCheckHTTPSConfig `json:"https_config,omitempty"`

	Port int32 `json:"port"`

	CheckTimeout *time.Duration `json:"check_timeout"`

	CheckDelay *time.Duration `json:"check_delay"`
}

HealthCheck health check

func (HealthCheck) MarshalJSON 

func (m HealthCheck) MarshalJSON() ([]byte, error)

func (*HealthCheck) UnmarshalJSON 

func (m *HealthCheck) UnmarshalJSON(b []byte) error

type HealthCheckHTTPConfig 

type HealthCheckHTTPConfig struct {
	URI string `json:"uri"`

	Method string `json:"method"`

	Code *int32 `json:"code"`
}

type HealthCheckHTTPSConfig 

type HealthCheckHTTPSConfig struct {
	URI string `json:"uri"`

	Method string `json:"method"`

	Code *int32 `json:"code"`
}

type HealthCheckLdapConfig 

type HealthCheckLdapConfig struct {
}

type HealthCheckMysqlConfig 

type HealthCheckMysqlConfig struct {
	User string `json:"user"`
}

type HealthCheckPgsqlConfig 

type HealthCheckPgsqlConfig struct {
	User string `json:"user"`
}

type HealthCheckRedisConfig 

type HealthCheckRedisConfig struct {
}

type HealthCheckTCPConfig 

type HealthCheckTCPConfig struct {
}

type IP 

type IP struct {
	ID string `json:"id"`

	IPAddress string `json:"ip_address"`

	OrganizationID string `json:"organization_id"`

	LbID *string `json:"lb_id"`

	Reverse string `json:"reverse"`

	Region scw.Region `json:"region"`
}

IP ip

type Instance 

type Instance struct {
	ID string `json:"id"`
	// Status
	//
	// Default value: unknown
	Status InstanceStatus `json:"status"`

	IPAddress string `json:"ip_address"`

	Region scw.Region `json:"region"`
}

type InstanceStatus 

type InstanceStatus string

func (InstanceStatus) MarshalJSON 

func (enum InstanceStatus) MarshalJSON() ([]byte, error)

func (InstanceStatus) String 

func (enum InstanceStatus) String() string

func (*InstanceStatus) UnmarshalJSON 

func (enum *InstanceStatus) UnmarshalJSON(data []byte) error

type Lb 

type Lb struct {
	ID string `json:"id"`

	Name string `json:"name"`

	Description string `json:"description"`
	// Status
	//
	// Default value: unknown
	Status LbStatus `json:"status"`

	Instances []*Instance `json:"instances"`

	OrganizationID string `json:"organization_id"`

	IP []*IP `json:"ip"`

	Tags []string `json:"tags"`

	FrontendCount int32 `json:"frontend_count"`

	BackendCount int32 `json:"backend_count"`

	Type string `json:"type"`

	Subscriber *Subscriber `json:"subscriber"`

	Region scw.Region `json:"region"`
}

Lb lb

type LbStats 

type LbStats struct {
	// BackendServersStats list stats object of your loadbalancer
	BackendServersStats []*BackendServerStats `json:"backend_servers_stats"`
}

LbStats lb stats

type LbStatus 

type LbStatus string

func (LbStatus) MarshalJSON 

func (enum LbStatus) MarshalJSON() ([]byte, error)

func (LbStatus) String 

func (enum LbStatus) String() string

func (*LbStatus) UnmarshalJSON 

func (enum *LbStatus) UnmarshalJSON(data []byte) error

type LbType 

type LbType struct {
	Name string `json:"name"`
	// StockStatus
	//
	// Default value: unknown
	StockStatus LbTypeStock `json:"stock_status"`

	Description string `json:"description"`

	Region scw.Region `json:"region"`
}

type LbTypeStock 

type LbTypeStock string

func (LbTypeStock) MarshalJSON 

func (enum LbTypeStock) MarshalJSON() ([]byte, error)

func (LbTypeStock) String 

func (enum LbTypeStock) String() string

func (*LbTypeStock) UnmarshalJSON 

func (enum *LbTypeStock) UnmarshalJSON(data []byte) error

type ListACLRequestOrderBy 

type ListACLRequestOrderBy string

func (ListACLRequestOrderBy) MarshalJSON 

func (enum ListACLRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListACLRequestOrderBy) String 

func (enum ListACLRequestOrderBy) String() string

func (*ListACLRequestOrderBy) UnmarshalJSON 

func (enum *ListACLRequestOrderBy) UnmarshalJSON(data []byte) error

type ListACLResponse 

type ListACLResponse struct {
	// ACLs list of Acl object (see Acl object description)
	ACLs []*ACL `json:"acls"`
	// TotalCount the total number of items
	TotalCount uint32 `json:"total_count"`
}

ListACLResponse list acl response

func (*ListACLResponse) UnsafeAppend 

func (r *ListACLResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListACLResponse) UnsafeGetTotalCount 

func (r *ListACLResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListACLsRequest 

type ListACLsRequest struct {
	Region scw.Region `json:"-"`
	// FrontendID iD of your frontend
	FrontendID string `json:"-"`
	// OrderBy you can order the response by created_at asc/desc or name asc/desc
	//
	// Default value: created_at_asc
	OrderBy ListACLRequestOrderBy `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize the number of items to return
	PageSize *uint32 `json:"-"`
	// Name filter acl per name
	Name *string `json:"-"`
}

type ListBackendStatsRequest 

type ListBackendStatsRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize the number of items to return
	PageSize *uint32 `json:"-"`
}

type ListBackendStatsResponse 

type ListBackendStatsResponse struct {
	// BackendServersStats list backend stats object of your loadbalancer
	BackendServersStats []*BackendServerStats `json:"backend_servers_stats"`
	// TotalCount the total number of items
	TotalCount uint32 `json:"total_count"`
}

ListBackendStatsResponse list backend stats response

func (*ListBackendStatsResponse) UnsafeAppend 

func (r *ListBackendStatsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListBackendStatsResponse) UnsafeGetTotalCount 

func (r *ListBackendStatsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListBackendsRequest 

type ListBackendsRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// Name use this to search by name
	Name *string `json:"-"`
	// OrderBy choose order of response
	//
	// Default value: created_at_asc
	OrderBy ListBackendsRequestOrderBy `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize the number of items to returns
	PageSize *uint32 `json:"-"`
}

type ListBackendsRequestOrderBy 

type ListBackendsRequestOrderBy string

func (ListBackendsRequestOrderBy) MarshalJSON 

func (enum ListBackendsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListBackendsRequestOrderBy) String 

func (enum ListBackendsRequestOrderBy) String() string

func (*ListBackendsRequestOrderBy) UnmarshalJSON 

func (enum *ListBackendsRequestOrderBy) UnmarshalJSON(data []byte) error

type ListBackendsResponse 

type ListBackendsResponse struct {
	// Backends list Backend objects of a Load Balancer
	Backends []*Backend `json:"backends"`
	// TotalCount total count, wihtout pagination
	TotalCount uint32 `json:"total_count"`
}

ListBackendsResponse list backends response

func (*ListBackendsResponse) UnsafeAppend 

func (r *ListBackendsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListBackendsResponse) UnsafeGetTotalCount 

func (r *ListBackendsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListCertificatesRequest 

type ListCertificatesRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// OrderBy you can order the response by created_at asc/desc or name asc/desc
	//
	// Default value: created_at_asc
	OrderBy ListCertificatesRequestOrderBy `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize the number of items to return
	PageSize *uint32 `json:"-"`
	// Name use this to search by name
	Name *string `json:"-"`
}

type ListCertificatesRequestOrderBy 

type ListCertificatesRequestOrderBy string

func (ListCertificatesRequestOrderBy) MarshalJSON 

func (enum ListCertificatesRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListCertificatesRequestOrderBy) String 

func (enum ListCertificatesRequestOrderBy) String() string

func (*ListCertificatesRequestOrderBy) UnmarshalJSON 

func (enum *ListCertificatesRequestOrderBy) UnmarshalJSON(data []byte) error

type ListCertificatesResponse 

type ListCertificatesResponse struct {
	Certificates []*Certificate `json:"certificates"`

	TotalCount uint32 `json:"total_count"`
}

func (*ListCertificatesResponse) UnsafeAppend 

func (r *ListCertificatesResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListCertificatesResponse) UnsafeGetTotalCount 

func (r *ListCertificatesResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListFrontendsRequest 

type ListFrontendsRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// Name use this to search by name
	Name *string `json:"-"`
	// OrderBy response order
	//
	// Default value: created_at_asc
	OrderBy ListFrontendsRequestOrderBy `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize the number of items to returns
	PageSize *uint32 `json:"-"`
}

type ListFrontendsRequestOrderBy 

type ListFrontendsRequestOrderBy string

func (ListFrontendsRequestOrderBy) MarshalJSON 

func (enum ListFrontendsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListFrontendsRequestOrderBy) String 

func (enum ListFrontendsRequestOrderBy) String() string

func (*ListFrontendsRequestOrderBy) UnmarshalJSON 

func (enum *ListFrontendsRequestOrderBy) UnmarshalJSON(data []byte) error

type ListFrontendsResponse 

type ListFrontendsResponse struct {
	// Frontends list frontends object of your loadbalancer
	Frontends []*Frontend `json:"frontends"`
	// TotalCount total count, wihtout pagination
	TotalCount uint32 `json:"total_count"`
}

ListFrontendsResponse list frontends response

func (*ListFrontendsResponse) UnsafeAppend 

func (r *ListFrontendsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListFrontendsResponse) UnsafeGetTotalCount 

func (r *ListFrontendsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListIPsRequest 

type ListIPsRequest struct {
	Region scw.Region `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize the number of items to return
	PageSize *uint32 `json:"-"`
	// IPAddress use this to search by IP address
	IPAddress *string `json:"-"`

	OrganizationID *string `json:"-"`
}

type ListIPsResponse 

type ListIPsResponse struct {
	// IPs list IP address object
	IPs []*IP `json:"ips"`
	// TotalCount total count, wihtout pagination
	TotalCount uint32 `json:"total_count"`
}

ListIPsResponse list ips response

func (*ListIPsResponse) UnsafeAppend 

func (r *ListIPsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListIPsResponse) UnsafeGetTotalCount 

func (r *ListIPsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListLbTypesRequest 

type ListLbTypesRequest struct {
	Region scw.Region `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize the number of items to return
	PageSize *uint32 `json:"-"`
}

type ListLbTypesResponse 

type ListLbTypesResponse struct {
	LbTypes []*LbType `json:"lb_types"`

	TotalCount uint32 `json:"total_count"`
}

func (*ListLbTypesResponse) UnsafeAppend 

func (r *ListLbTypesResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListLbTypesResponse) UnsafeGetTotalCount 

func (r *ListLbTypesResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListLbsRequest 

type ListLbsRequest struct {
	Region scw.Region `json:"-"`
	// Name use this to search by name
	Name *string `json:"-"`
	// OrderBy
	//
	// Default value: created_at_asc
	OrderBy ListLbsRequestOrderBy `json:"-"`

	PageSize *uint32 `json:"-"`

	Page *int32 `json:"-"`

	OrganizationID *string `json:"-"`
}

type ListLbsRequestOrderBy 

type ListLbsRequestOrderBy string

func (ListLbsRequestOrderBy) MarshalJSON 

func (enum ListLbsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListLbsRequestOrderBy) String 

func (enum ListLbsRequestOrderBy) String() string

func (*ListLbsRequestOrderBy) UnmarshalJSON 

func (enum *ListLbsRequestOrderBy) UnmarshalJSON(data []byte) error

type ListLbsResponse 

type ListLbsResponse struct {
	Lbs []*Lb `json:"lbs"`

	TotalCount uint32 `json:"total_count"`
}

ListLbsResponse list lbs response

func (*ListLbsResponse) UnsafeAppend 

func (r *ListLbsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListLbsResponse) UnsafeGetTotalCount 

func (r *ListLbsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListSubscriberRequest 

type ListSubscriberRequest struct {
	Region scw.Region `json:"-"`
	// OrderBy you can order the response by created_at asc/desc or name asc/desc
	//
	// Default value: created_at_asc
	OrderBy ListSubscriberRequestOrderBy `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize the number of items to return
	PageSize *uint32 `json:"-"`
	// Name use this to search by name
	Name *string `json:"-"`
	// OrganizationID owner of resources
	OrganizationID *string `json:"-"`
}

type ListSubscriberRequestOrderBy 

type ListSubscriberRequestOrderBy string

func (ListSubscriberRequestOrderBy) MarshalJSON 

func (enum ListSubscriberRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListSubscriberRequestOrderBy) String 

func (enum ListSubscriberRequestOrderBy) String() string

func (*ListSubscriberRequestOrderBy) UnmarshalJSON 

func (enum *ListSubscriberRequestOrderBy) UnmarshalJSON(data []byte) error

type ListSubscriberResponse 

type ListSubscriberResponse struct {
	// Subscribers list of Subscribers object
	Subscribers []*Subscriber `json:"subscribers"`
	// TotalCount the total number of items
	TotalCount uint32 `json:"total_count"`
}

ListSubscriberResponse list subscriber response

func (*ListSubscriberResponse) UnsafeAppend 

func (r *ListSubscriberResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListSubscriberResponse) UnsafeGetTotalCount 

func (r *ListSubscriberResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type OnMarkedDownAction 

type OnMarkedDownAction string

func (OnMarkedDownAction) MarshalJSON 

func (enum OnMarkedDownAction) MarshalJSON() ([]byte, error)

func (OnMarkedDownAction) String 

func (enum OnMarkedDownAction) String() string

func (*OnMarkedDownAction) UnmarshalJSON 

func (enum *OnMarkedDownAction) UnmarshalJSON(data []byte) error

type Protocol 

type Protocol string

func (Protocol) MarshalJSON 

func (enum Protocol) MarshalJSON() ([]byte, error)

func (Protocol) String 

func (enum Protocol) String() string

func (*Protocol) UnmarshalJSON 

func (enum *Protocol) UnmarshalJSON(data []byte) error

type ProxyProtocol 

type ProxyProtocol string

ProxyProtocol pROXY protocol, forward client's address (must be supported by backend servers software)

The PROXY protocol informs the other end about the incoming connection, so that it can know the client's address or the public address it accessed to, whatever the upper layer protocol.

* `proxy_protocol_none` Disable proxy protocol. * `proxy_protocol_v1` Version one (text format). * `proxy_protocol_v2` Version two (binary format). * `proxy_protocol_v2_ssl` Version two with SSL connection. * `proxy_protocol_v2_ssl_cn` Version two with SSL connection and common name information.

func (ProxyProtocol) MarshalJSON 

func (enum ProxyProtocol) MarshalJSON() ([]byte, error)

func (ProxyProtocol) String 

func (enum ProxyProtocol) String() string

func (*ProxyProtocol) UnmarshalJSON 

func (enum *ProxyProtocol) UnmarshalJSON(data []byte) error

type ReleaseIPRequest 

type ReleaseIPRequest struct {
	Region scw.Region `json:"-"`
	// IPID iP address ID
	IPID string `json:"-"`
}

type RemoveBackendServersRequest 

type RemoveBackendServersRequest struct {
	Region scw.Region `json:"-"`
	// BackendID backend ID
	BackendID string `json:"-"`
	// ServerIP set all IPs to remove of your backend
	ServerIP []string `json:"server_ip"`
}

type SetBackendServersRequest 

type SetBackendServersRequest struct {
	Region scw.Region `json:"-"`
	// BackendID backend ID
	BackendID string `json:"-"`
	// ServerIP set all IPs to add on your backend and remove all other
	ServerIP []string `json:"server_ip"`
}

type StickySessionsType 

type StickySessionsType string

func (StickySessionsType) MarshalJSON 

func (enum StickySessionsType) MarshalJSON() ([]byte, error)

func (StickySessionsType) String 

func (enum StickySessionsType) String() string

func (*StickySessionsType) UnmarshalJSON 

func (enum *StickySessionsType) UnmarshalJSON(data []byte) error

type SubscribeToLbRequest 

type SubscribeToLbRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// SubscriberID subscriber ID
	SubscriberID string `json:"subscriber_id"`
}

type Subscriber 

type Subscriber struct {
	// ID subscriber ID
	ID string `json:"id"`
	// Name subscriber name
	Name string `json:"name"`
	// EmailConfig email address of subscriber
	// Precisely one of EmailConfig, WebhookConfig must be set.
	EmailConfig *SubscriberEmailConfig `json:"email_config,omitempty"`
	// WebhookConfig webHook URI of subscriber
	// Precisely one of EmailConfig, WebhookConfig must be set.
	WebhookConfig *SubscriberWebhookConfig `json:"webhook_config,omitempty"`
}

Subscriber subscriber

type SubscriberEmailConfig 

type SubscriberEmailConfig struct {
	// Email email who receive alert
	Email string `json:"email"`
}

SubscriberEmailConfig email alert of subscriber

type SubscriberWebhookConfig 

type SubscriberWebhookConfig struct {
	// URI uRI who receive POST request
	URI string `json:"uri"`
}

SubscriberWebhookConfig webhook alert of subscriber

type UnsubscribeFromLbRequest 

type UnsubscribeFromLbRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
}

type UpdateACLRequest 

type UpdateACLRequest struct {
	Region scw.Region `json:"-"`
	// ACLID iD of your ACL ressource
	ACLID string `json:"-"`
	// Name name of your ACL ressource
	Name string `json:"name"`
	// Action see the AclAction object description
	Action *ACLAction `json:"action"`
	// Match see the AclMatch object description
	Match *ACLMatch `json:"match"`
	// Index order between your Acls (ascending order, 0 is first acl executed)
	Index int32 `json:"index"`
}

type UpdateBackendRequest 

type UpdateBackendRequest struct {
	Region scw.Region `json:"-"`

	BackendID string `json:"-"`

	Name string `json:"name"`
	// ForwardProtocol
	//
	// Default value: tcp
	ForwardProtocol Protocol `json:"forward_protocol"`

	ForwardPort int32 `json:"forward_port"`
	// ForwardPortAlgorithm
	//
	// Default value: roundrobin
	ForwardPortAlgorithm ForwardPortAlgorithm `json:"forward_port_algorithm"`
	// StickySessions
	//
	// Default value: none
	StickySessions StickySessionsType `json:"sticky_sessions"`

	StickySessionsCookieName string `json:"sticky_sessions_cookie_name"`

	SendProxyV2 bool `json:"send_proxy_v2"`

	TimeoutServer *time.Duration `json:"timeout_server"`

	TimeoutConnect *time.Duration `json:"timeout_connect"`

	TimeoutTunnel *time.Duration `json:"timeout_tunnel"`
	// OnMarkedDownAction
	//
	// Default value: on_marked_down_action_none
	OnMarkedDownAction OnMarkedDownAction `json:"on_marked_down_action"`
	// ProxyProtocol
	//
	// Default value: proxy_protocol_unknown
	ProxyProtocol ProxyProtocol `json:"proxy_protocol"`
}

func (UpdateBackendRequest) MarshalJSON 

func (m UpdateBackendRequest) MarshalJSON() ([]byte, error)

func (*UpdateBackendRequest) UnmarshalJSON 

func (m *UpdateBackendRequest) UnmarshalJSON(b []byte) error

type UpdateCertificateRequest 

type UpdateCertificateRequest struct {
	Region scw.Region `json:"-"`
	// CertificateID certificate ID
	CertificateID string `json:"-"`
	// Name certificate name
	Name string `json:"name"`
}

type UpdateFrontendRequest 

type UpdateFrontendRequest struct {
	Region scw.Region `json:"-"`
	// FrontendID frontend ID
	FrontendID string `json:"-"`
	// Name resource name
	Name string `json:"name"`
	// InboundPort tCP port to listen on the front side
	InboundPort int32 `json:"inbound_port"`
	// BackendID backend ID
	BackendID string `json:"backend_id"`
	// TimeoutClient client session maximum inactivity time
	TimeoutClient *time.Duration `json:"timeout_client"`
	// CertificateID certificate ID
	CertificateID *string `json:"certificate_id"`
}

func (UpdateFrontendRequest) MarshalJSON 

func (m UpdateFrontendRequest) MarshalJSON() ([]byte, error)

func (*UpdateFrontendRequest) UnmarshalJSON 

func (m *UpdateFrontendRequest) UnmarshalJSON(b []byte) error

type UpdateHealthCheckRequest 

type UpdateHealthCheckRequest struct {
	Region scw.Region `json:"-"`
	// BackendID backend ID
	BackendID string `json:"-"`
	// Port specify the port used to health check
	Port int32 `json:"port"`
	// CheckDelay time between two consecutive health checks
	CheckDelay *time.Duration `json:"check_delay"`
	// CheckTimeout additional check timeout, after the connection has been already established
	CheckTimeout *time.Duration `json:"check_timeout"`
	// CheckMaxRetries number of consecutive unsuccessful health checks, after wich the server will be considered dead
	CheckMaxRetries int32 `json:"check_max_retries"`
	// MysqlConfig the check requires MySQL >=3.22, for older version, please use TCP check
	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	MysqlConfig *HealthCheckMysqlConfig `json:"mysql_config,omitempty"`
	// LdapConfig the response is analyzed to find an LDAPv3 response message
	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	LdapConfig *HealthCheckLdapConfig `json:"ldap_config,omitempty"`
	// RedisConfig the response is analyzed to find the +PONG response message
	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	RedisConfig *HealthCheckRedisConfig `json:"redis_config,omitempty"`

	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	PgsqlConfig *HealthCheckPgsqlConfig `json:"pgsql_config,omitempty"`

	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	TCPConfig *HealthCheckTCPConfig `json:"tcp_config,omitempty"`

	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	HTTPConfig *HealthCheckHTTPConfig `json:"http_config,omitempty"`

	// Precisely one of HTTPConfig, HTTPSConfig, LdapConfig, MysqlConfig, PgsqlConfig, RedisConfig, TCPConfig must be set.
	HTTPSConfig *HealthCheckHTTPSConfig `json:"https_config,omitempty"`
}

func (UpdateHealthCheckRequest) MarshalJSON 

func (m UpdateHealthCheckRequest) MarshalJSON() ([]byte, error)

func (*UpdateHealthCheckRequest) UnmarshalJSON 

func (m *UpdateHealthCheckRequest) UnmarshalJSON(b []byte) error

type UpdateIPRequest 

type UpdateIPRequest struct {
	Region scw.Region `json:"-"`
	// IPID iP address ID
	IPID string `json:"-"`
	// Reverse reverse DNS
	Reverse *string `json:"reverse"`
}

type UpdateLbRequest 

type UpdateLbRequest struct {
	Region scw.Region `json:"-"`
	// LbID load Balancer ID
	LbID string `json:"-"`
	// Name resource name
	Name string `json:"name"`
	// Description resource description
	Description string `json:"description"`
	// Tags list of keywords
	Tags []string `json:"tags"`
}

type UpdateSubscriberRequest 

type UpdateSubscriberRequest struct {
	Region scw.Region `json:"-"`
	// SubscriberID subscriber ID
	SubscriberID string `json:"-"`
	// Name subscriber name
	Name string `json:"name"`
	// EmailConfig email address configuration
	// Precisely one of EmailConfig, WebhookConfig must be set.
	EmailConfig *SubscriberEmailConfig `json:"email_config,omitempty"`
	// WebhookConfig webHook URI configuration
	// Precisely one of EmailConfig, WebhookConfig must be set.
	WebhookConfig *SubscriberWebhookConfig `json:"webhook_config,omitempty"`
}

type WaitForLbRequest 

type WaitForLbRequest struct {
	LbID    string
	Region  scw.Region
	Timeout time.Duration
}

WaitForLbRequest is used by WaitForLb method.

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.