listeners

package
v0.9.3 Latest Latest
Warning

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

 Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 4 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func List added in v0.5.6 

func List(client *golangsdk.ServiceClient, opts ListOptsBuilder) pagination.Pager

Types

type CreateOpts 

type CreateOpts struct {
	// The administrative state of the Listener. A valid value is true (UP)
	// or false (DOWN).
	AdminStateUp *bool `json:"admin_state_up,omitempty"`

	// the ID of the CA certificate used by the listener.
	CAContainerRef string `json:"client_ca_tls_container_ref,omitempty"`

	// The ID of the default pool with which the Listener is associated.
	DefaultPoolID string `json:"default_pool_id,omitempty"`

	// A reference to a Barbican container of TLS secrets.
	DefaultTlsContainerRef string `json:"default_tls_container_ref,omitempty"`

	// Provides supplementary information about the Listener.
	Description string `json:"description,omitempty"`

	// whether to use HTTP2.
	Http2Enable *bool `json:"http2_enable,omitempty"`

	// The load balancer on which to provision this listener.
	LoadbalancerID string `json:"loadbalancer_id" required:"true"`

	// Specifies the Listener name.
	Name string `json:"name,omitempty"`

	// ProjectID is only required if the caller has an admin role and wants
	// to create a pool for another project.
	ProjectID string `json:"project_id,omitempty"`

	// The protocol - can either be TCP, HTTP or HTTPS.
	Protocol Protocol `json:"protocol" required:"true"`

	// The port on which to listen for client traffic.
	ProtocolPort int `json:"protocol_port" required:"true"`

	// A list of references to TLS secrets.
	SniContainerRefs []string `json:"sni_container_refs,omitempty"`

	// Specifies how wildcard domain name matches with the SNI certificates used by the listener.
	// longest_suffix indicates longest suffix match. wildcard indicates wildcard match.
	// The default value is wildcard.
	SniMatchAlgo string `json:"sni_match_algo,omitempty"`

	// A list of Tags.
	Tags []tags.ResourceTag `json:"tags,omitempty"`

	// Specifies the security policy used by the listener.
	TlsCiphersPolicy string `json:"tls_ciphers_policy,omitempty"`

	// Specifies the ID of the custom security policy.
	// Note:
	// This parameter is available only for HTTPS listeners added to a dedicated load balancer.
	// If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.
	// The priority of the encryption suite from high to low is: ecc suite: ecc suite, rsa suite, tls 1.3 suite (supporting both ecc and rsa).
	SecurityPolicy string `json:"security_policy_id,omitempty"`

	// Whether enable member retry
	EnableMemberRetry *bool `json:"enable_member_retry,omitempty"`

	// The keepalive timeout of the Listener.
	KeepAliveTimeout int `json:"keepalive_timeout,omitempty"`

	// The client timeout of the Listener.
	ClientTimeout int `json:"client_timeout,omitempty"`

	// The member timeout of the Listener.
	MemberTimeout int `json:"member_timeout,omitempty"`

	// The IpGroup of the Listener.
	IpGroup *IpGroup `json:"ipgroup,omitempty"`

	// The http insert headers of the Listener.
	InsertHeaders *InsertHeaders `json:"insert_headers,omitempty"`

	// Transparent client ip enable
	TransparentClientIP *bool `json:"transparent_client_ip_enable,omitempty"`

	// Enhance L7policy enable
	EnhanceL7policy *bool `json:"enhance_l7policy_enable,omitempty"`
}

CreateOpts represents options for creating a listener.

func (CreateOpts) ToListenerCreateMap 

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

ToListenerCreateMap builds a request body from CreateOpts.

type CreateOptsBuilder 

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

CreateOptsBuilder allows extensions to add additional parameters to the Create request.

type CreateResult 

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

CreateResult represents the result of a create operation. Call its Extract method to interpret it as a Listener.

func Create 

func Create(client *golangsdk.ServiceClient, opts CreateOptsBuilder) (r CreateResult)

Create is an operation which provisions a new Listeners 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 Listeners on behalf of other tenants by specifying a TenantID attribute different from their own.

func (CreateResult) Extract 

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

Extract is a function that accepts a result and extracts a listener.

type DeleteResult 

type DeleteResult struct {
	golangsdk.ErrResult
}

DeleteResult represents the result of a delete operation. Call its ExtractErr method to determine if the request succeeded or failed.

func Delete 

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

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

type GetResult 

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

GetResult represents the result of a get operation. Call its Extract method to interpret it as a Listener.

func Get 

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

Get retrieves a particular Listeners based on its unique ID.

func (GetResult) Extract 

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

Extract is a function that accepts a result and extracts a listener.

type InsertHeaders 

type InsertHeaders struct {
	ForwardedELBIP   *bool `json:"X-Forwarded-ELB-IP,omitempty"`
	ForwardedPort    *bool `json:"X-Forwarded-Port,omitempty"`
	ForwardedForPort *bool `json:"X-Forwarded-For-Port,omitempty"`
	ForwardedHost    *bool `json:"X-Forwarded-Host" required:"true"`
}

type IpGroup 

type IpGroup struct {
	IpGroupID string `json:"ipgroup_id" required:"true"`
	Enable    *bool  `json:"enable_ipgroup,omitempty"`
	Type      string `json:"type,omitempty"`
}

type IpGroupUpdate 

type IpGroupUpdate struct {
	IpGroupId string `json:"ipgroup_id,omitempty"`
	Enable    *bool  `json:"enable_ipgroup,omitempty"`
	Type      string `json:"type,omitempty"`
}

type ListOpts added in v0.5.6 

type ListOpts struct {
	Limit       int    `q:"limit"`
	Marker      string `q:"marker"`
	PageReverse bool   `q:"page_reverse"`

	ProtocolPort            []int      `q:"protocol_port"`
	Protocol                []Protocol `q:"protocol"`
	Description             []string   `q:"description"`
	DefaultTLSContainerRef  []string   `q:"default_tls_container_ref"`
	ClientCATLSContainerRef []string   `q:"client_ca_tls_container_ref"`
	DefaultPoolID           []string   `q:"default_pool_id"`
	ID                      []string   `q:"id"`
	Name                    []string   `q:"name"`
	LoadBalancerID          []string   `q:"loadbalancer_id"`
	TLSCiphersPolicy        []string   `q:"tls_ciphers_policy"`
	MemberAddress           []string   `q:"member_address"`
	MemberDeviceID          []string   `q:"member_device_id"`
	MemberTimeout           []int      `q:"member_timeout"`
	ClientTimeout           []int      `q:"client_timeout"`
	KeepAliveTimeout        []int      `q:"keepalive_timeout"`
}

func (ListOpts) ToListenerListQuery added in v0.5.6 

func (opts ListOpts) ToListenerListQuery() (string, error)

type ListOptsBuilder added in v0.5.6 

type ListOptsBuilder interface {
	ToListenerListQuery() (string, error)
}

type Listener 

type Listener struct {
	// The unique ID for the Listener.
	ID string `json:"id"`

	// The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
	AdminStateUp bool `json:"admin_state_up"`

	// The ID of the CA certificate used by the listener.
	CAContainerRef string `json:"client_ca_tls_container_ref"`

	// The maximum number of connections allowed for the Loadbalancer.
	// Default is -1, meaning no limit.
	ConnectionLimit int `json:"connection_limit"`

	// Specifies the time when the listener was created.
	CreatedAt string `json:"created_at"`

	// Specifies the time when the listener was updated.
	UpdatedAt string `json:"updated_at"`

	// The UUID of default pool. Must have compatible protocol with listener.
	DefaultPoolID string `json:"default_pool_id"`

	// A reference to a Barbican container of TLS secrets.
	DefaultTlsContainerRef string `json:"default_tls_container_ref"`

	// Provides supplementary information about the Listener.
	Description string `json:"description"`

	// whether to use HTTP2.
	Http2Enable bool `json:"http2_enable"`

	// A list of load balancer IDs.
	Loadbalancers []structs.ResourceRef `json:"loadbalancers"`

	// Specifies the Listener Name.
	Name string `json:"name"`

	// Specifies the ProjectID where the listener is used.
	ProjectID string `json:"project_id"`

	// The protocol to loadbalancer. A valid value is TCP, HTTP, or HTTPS.
	Protocol string `json:"protocol"`

	// The port on which to listen to client traffic that is associated with the
	// Loadbalancer. A valid value is from 0 to 65535.
	ProtocolPort int `json:"protocol_port"`

	// The list of references to TLS secrets.
	SniContainerRefs []string `json:"sni_container_refs"`

	// SNI certificates wildcard.
	SniMatchAlgo string `json:"sni_match_algo"`

	// Lists the Tags.
	Tags []tags.ResourceTag `json:"tags"`

	// Specifies the security policy used by the listener.
	TlsCiphersPolicy string `json:"tls_ciphers_policy"`

	SecurityPolicy string `json:"security_policy_id"`

	// Whether enable member retry
	EnableMemberRetry bool `json:"enable_member_retry"`

	// The keepalive timeout of the Listener.
	KeepAliveTimeout int `json:"keepalive_timeout"`

	// The client timeout of the Listener.
	ClientTimeout int `json:"client_timeout"`

	// The member timeout of the Listener.
	MemberTimeout int `json:"member_timeout"`

	// The ipgroup of the Listener.
	IpGroup IpGroup `json:"ipgroup"`

	// The http insert headers of the Listener.
	InsertHeaders InsertHeaders `json:"insert_headers"`

	// Transparent client ip enable
	TransparentClientIP bool `json:"transparent_client_ip_enable"`

	// Enhance L7policy enable
	EnhanceL7policy bool `json:"enhance_l7policy_enable"`
}

Listener is the primary load balancing configuration object that specifies the loadbalancer and port on which client traffic is received, as well as other details such as the load balancing method to be use, protocol, etc.

func ExtractListeners added in v0.5.6 

func ExtractListeners(r pagination.Page) ([]Listener, error)

type ListenerPage added in v0.5.6 

type ListenerPage struct {
	pagination.PageWithInfo
}

func (ListenerPage) IsEmpty added in v0.5.6 

func (p ListenerPage) IsEmpty() (bool, error)

type Protocol 

type Protocol string

Protocol represents a listener protocol. 

const (
	ProtocolTCP   Protocol = "TCP"
	ProtocolUDP   Protocol = "UDP"
	ProtocolHTTP  Protocol = "HTTP"
	ProtocolHTTPS Protocol = "HTTPS"
)

Supported attributes for create/update operations.

type UpdateOpts 

type UpdateOpts struct {
	// The administrative state of the Listener. A valid value is true (UP)
	// or false (DOWN).
	AdminStateUp *bool `json:"admin_state_up,omitempty"`

	// the ID of the CA certificate used by the listener.
	CAContainerRef *string `json:"client_ca_tls_container_ref,omitempty"`

	// The ID of the default pool with which the Listener is associated.
	DefaultPoolID string `json:"default_pool_id,omitempty"`

	// A reference to a container of TLS secrets.
	DefaultTlsContainerRef *string `json:"default_tls_container_ref,omitempty"`

	// Provides supplementary information about the Listener.
	Description *string `json:"description,omitempty"`

	// whether to use HTTP2.
	Http2Enable *bool `json:"http2_enable,omitempty"`

	// Specifies the Listener name.
	Name *string `json:"name,omitempty"`

	// A list of references to TLS secrets.
	SniContainerRefs *[]string `json:"sni_container_refs,omitempty"`

	// Specifies how wildcard domain name matches with the SNI certificates used by the listener.
	// longest_suffix indicates longest suffix match. wildcard indicates wildcard match.
	// The default value is wildcard.
	SniMatchAlgo string `json:"sni_match_algo,omitempty"`

	// Specifies the security policy used by the listener.
	TlsCiphersPolicy *string `json:"tls_ciphers_policy,omitempty"`

	// Specifies the ID of the custom security policy.
	// Note:
	// This parameter is available only for HTTPS listeners added to a dedicated load balancer.
	// If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.
	// The priority of the encryption suite from high to low is: ecc suite: ecc suite, rsa suite, tls 1.3 suite (supporting both ecc and rsa).
	SecurityPolicy string `json:"security_policy_id,omitempty"`

	// Whether enable member retry
	EnableMemberRetry *bool `json:"enable_member_retry,omitempty"`

	// The keepalive timeout of the Listener.
	KeepAliveTimeout int `json:"keepalive_timeout,omitempty"`

	// The client timeout of the Listener.
	ClientTimeout int `json:"client_timeout,omitempty"`

	// The member timeout of the Listener.
	MemberTimeout int `json:"member_timeout,omitempty"`

	// The IpGroup of the Listener.
	IpGroup *IpGroupUpdate `json:"ipgroup,omitempty"`

	// The http insert headers of the Listener.
	InsertHeaders *InsertHeaders `json:"insert_headers,omitempty"`

	// Transparent client ip enable
	TransparentClientIP *bool `json:"transparent_client_ip_enable,omitempty"`

	// Enhance L7policy enable
	EnhanceL7policy *bool `json:"enhance_l7policy_enable,omitempty"`
}

UpdateOpts represents options for updating a Listener.

func (UpdateOpts) ToListenerUpdateMap 

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

ToListenerUpdateMap builds a request body from UpdateOpts.

type UpdateOptsBuilder 

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

UpdateOptsBuilder allows extensions to add additional parameters to the Update request.

type UpdateResult 

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

UpdateResult represents the result of an update operation. Call its Extract method to interpret it as a Listener.

func Update 

func Update(client *golangsdk.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)

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

func (UpdateResult) Extract 

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

Extract is a function that accepts a result and extracts a listener.

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.