listeners

Documentation

Index

• type CreateOpts
  • func (opts CreateOpts) ToListenerCreateMap() (map[string]interface{}, error)
• type CreateOptsBuilder
• type CreateResponse
• type CreateResult
  • func Create(c *golangsdk.ServiceClient, opts CreateOptsBuilder, not_pass_param []string) (r CreateResult)
  • func (r CreateResult) Extract() (*CreateResponse, error)
• type DeleteResult
  • func Delete(c *golangsdk.ServiceClient, id string) (r DeleteResult)
• type GetResult
  • func Get(c *golangsdk.ServiceClient, id string) (r GetResult)
  • func (r GetResult) Extract() (*Listener, error)
• type Listener
• type UpdateOpts
  • func (opts UpdateOpts) ToListenerUpdateMap() (map[string]interface{}, error)
• type UpdateOptsBuilder
• type UpdateResponse
• type UpdateResult
  • func Update(c *golangsdk.ServiceClient, id string, opts UpdateOpts, ...) (r UpdateResult)
  • func (r UpdateResult) Extract() (*UpdateResponse, error)

Types

type CreateOpts

type CreateOpts struct {
	Name               string   `json:"name" required:"true"`
	Description        string   `json:"description,omitempty"`
	LoadbalancerID     string   `json:"loadbalancer_id" required:"true"`
	Protocol           string   `json:"protocol" required:"true"`
	Port               int      `json:"port" required:"true"`
	BackendProtocol    string   `json:"backend_protocol" required:"true"`
	BackendPort        int      `json:"backend_port" required:"true"`
	LbAlgorithm        string   `json:"lb_algorithm" required:"true"`
	SessionSticky      bool     `json:"session_sticky" no_default:"y"`
	StickySessionType  string   `json:"sticky_session_type,omitempty"`
	CookieTimeout      int      `json:"cookie_timeout,omitempty"`
	TcpTimeout         int      `json:"tcp_timeout,omitempty"`
	TcpDraining        bool     `json:"tcp_draining" no_default:"y"`
	TcpDrainingTimeout int      `json:"tcp_draining_timeout" no_default:"y"`
	CertificateID      string   `json:"certificate_id,omitempty"`
	Certificates       []string `json:"certificates,omitempty"`
	UdpTimeout         int      `json:"udp_timeout,omitempty"`
	SslProtocols       string   `json:"ssl_protocols,omitempty"`
	SslCiphers         string   `json:"ssl_ciphers,omitempty"`
}

CreateOpts is the common options struct used in this package's Create operation.

func (CreateOpts) ToListenerCreateMap

func (opts CreateOpts) ToListenerCreateMap() (map[string]interface{}, error)

ToListenerCreateMap casts a CreateOpts struct to a map.

type CreateOptsBuilder

type CreateOptsBuilder interface {
	ToListenerCreateMap() (map[string]interface{}, error)
}

CreateOptsBuilder is the interface options structs have to satisfy in order to be used in the main Create operation in this package. Since many extensions decorate or modify the common logic, it is useful for them to satisfy a basic interface in order for them to be used.

type CreateResponse

type CreateResponse struct {
	UpdateTime         string   `json:"update_time"`
	BackendPort        int      `json:"backend_port"`
	ID                 string   `json:"id"`
	BackendProtocol    string   `json:"backend_protocol"`
	StickySessionType  string   `json:"sticky_session_type"`
	Description        string   `json:"description"`
	LoadbalancerID     string   `json:"loadbalancer_id"`
	CreateTime         string   `json:"create_time"`
	Status             string   `json:"status"`
	Protocol           string   `json:"protocol"`
	Port               int      `json:"port"`
	CookieTimeout      int      `json:"cookie_timeout"`
	AdminStateUp       bool     `json:"admin_state_up"`
	SessionSticky      bool     `json:"session_sticky"`
	LbAlgorithm        string   `json:"lb_algorithm"`
	Name               string   `json:"name"`
	TcpDraining        bool     `json:"tcp_draining"`
	TcpDrainingTimeout int      `json:"tcp_draining_timeout"`
	SslProtocols       string   `json:"ssl_protocols"`
	SslCiphers         string   `json:"ssl_ciphers"`
	CertificateID      string   `json:"certificate_id"`
	Certificates       []string `json:"certificates"`
}

type CreateResult

type CreateResult struct {
	golangsdk.Result
}

func Create

func Create(c *golangsdk.ServiceClient, opts CreateOptsBuilder, not_pass_param []string) (r CreateResult)

Create is an operation which provisions a new loadbalancer based on the configuration defined in the CreateOpts struct. Once the request is validated and progress has started on the provisioning process, a CreateResult will be returned.

Users with an admin role can create loadbalancers on behalf of other tenants by specifying a TenantID attribute different than their own.

func (CreateResult) Extract

func (r CreateResult) Extract() (*CreateResponse, error)

type DeleteResult

type DeleteResult struct {
	golangsdk.ErrResult
}

DeleteResult represents the result of a delete operation.

func Delete

func Delete(c *golangsdk.ServiceClient, id string) (r DeleteResult)

Delete will permanently delete a particular Listener based on its unique ID.

type GetResult

type GetResult struct {
	golangsdk.Result
}

GetResult represents the result of a get operation.

func Get

func Get(c *golangsdk.ServiceClient, id string) (r GetResult)

Get retrieves a particular Loadbalancer based on its unique ID.

func (GetResult) Extract

func (r GetResult) Extract() (*Listener, error)

type Listener

type Listener struct {
	UpdateTime         string   `json:"update_time"`
	BackendPort        int      `json:"backend_port"`
	ID                 string   `json:"id"`
	BackendProtocol    string   `json:"backend_protocol"`
	StickySessionType  string   `json:"sticky_session_type"`
	Description        string   `json:"description"`
	LoadbalancerID     string   `json:"loadbalancer_id"`
	CreateTime         string   `json:"create_time"`
	Status             string   `json:"status"`
	Protocol           string   `json:"protocol"`
	Port               int      `json:"port"`
	CookieTimeout      int      `json:"cookie_timeout"`
	AdminStateUp       bool     `json:"admin_state_up"`
	MemberNumber       int      `json:"member_number"`
	HealthcheckID      string   `json:"healthcheck_id"`
	SessionSticky      bool     `json:"session_sticky"`
	LbAlgorithm        string   `json:"lb_algorithm"`
	Name               string   `json:"name"`
	CertificateID      string   `json:"certificate_id"`
	Certificates       []string `json:"certificates"`
	TcpDraining        bool     `json:"tcp_draining"`
	TcpDrainingTimeout int      `json:"tcp_draining_timeout"`
	TcpTimeout         int      `json:"tcp_timeout"`
	UdpTimeout         int      `json:"udp_timeout"`
	SslProtocols       string   `json:"ssl_protocols"`
	SslCiphers         string   `json:"ssl_ciphers"`
}

type UpdateOpts

type UpdateOpts struct {
	Name               string   `json:"name,omitempty"`
	Description        string   `json:"description"`
	Port               int      `json:"port,omitempty"`
	BackendPort        int      `json:"backend_port,omitempty"`
	LbAlgorithm        string   `json:"lb_algorithm,omitempty"`
	TcpTimeout         int      `json:"tcp_timeout,omitempty"`
	TcpDraining        bool     `json:"tcp_draining"`
	TcpDrainingTimeout int      `json:"tcp_draining_timeout"`
	UdpTimeout         int      `json:"udp_timeout,omitempty"`
	SslProtocols       string   `json:"ssl_protocols,omitempty"`
	SslCiphers         string   `json:"ssl_ciphers,omitempty"`
	CertificateID      string   `json:"certificate_id,omitempty"`
	Certificates       []string `json:"certificates,omitempty"`
}

UpdateOpts is the common options struct used in this package's Update operation.

func (UpdateOpts) ToListenerUpdateMap

func (opts UpdateOpts) ToListenerUpdateMap() (map[string]interface{}, error)

ToListenerUpdateMap casts a UpdateOpts struct to a map.

type UpdateOptsBuilder

type UpdateOptsBuilder interface {
	ToListenerUpdateMap() (map[string]interface{}, error)
}

UpdateOptsBuilder is the interface options structs have to satisfy in order to be used in the main Update operation in this package. Since many extensions decorate or modify the common logic, it is useful for them to satisfy a basic interface in order for them to be used.

type UpdateResponse

type UpdateResponse struct {
	UpdateTime         string   `json:"update_time"`
	BackendPort        int      `json:"backend_port"`
	ID                 string   `json:"id"`
	BackendProtocol    string   `json:"backend_protocol"`
	StickySessionType  string   `json:"sticky_session_type"`
	Description        string   `json:"description"`
	LoadbalancerID     string   `json:"loadbalancer_id"`
	CreateTime         string   `json:"create_time"`
	Status             string   `json:"status"`
	Protocol           string   `json:"protocol"`
	Port               int      `json:"port"`
	CookieTimeout      int      `json:"cookie_timeout"`
	AdminStateUp       bool     `json:"admin_state_up"`
	HealthcheckID      string   `json:"healthcheck_id"`
	SessionSticky      bool     `json:"session_sticky"`
	LbAlgorithm        string   `json:"lb_algorithm"`
	Name               string   `json:"name"`
	TcpDraining        bool     `json:"tcp_draining"`
	TcpDrainingTimeout int      `json:"tcp_draining_timeout"`
	CertificateID      string   `json:"certificate_id"`
	Certificates       []string `json:"certificates"`
}

type UpdateResult

type UpdateResult struct {
	golangsdk.Result
}

func Update

func Update(c *golangsdk.ServiceClient, id string, opts UpdateOpts, not_pass_param []string) (r UpdateResult)

Update is an operation which modifies the attributes of the specified Listener.

func (UpdateResult) Extract

func (r UpdateResult) Extract() (*UpdateResponse, error)