globalloadbalancerv1

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2020 License: Apache-2.0 Imports: 4 Imported by: 7

Documentation

Overview

Package globalloadbalancerv1 : Operations and models for the GlobalLoadBalancerV1 service

Index

Constants

View Source 
const (
	CreateLoadBalancerOptions_SessionAffinity_Cookie   = "cookie"
	CreateLoadBalancerOptions_SessionAffinity_IpCookie = "ip_cookie"
	CreateLoadBalancerOptions_SessionAffinity_None     = "none"
)

Constants associated with the CreateLoadBalancerOptions.SessionAffinity property. session affinity.

View Source 
const (
	CreateLoadBalancerOptions_SteeringPolicy_DynamicLatency = "dynamic_latency"
	CreateLoadBalancerOptions_SteeringPolicy_Geo            = "geo"
	CreateLoadBalancerOptions_SteeringPolicy_Off            = "off"
	CreateLoadBalancerOptions_SteeringPolicy_Random         = "random"
)

Constants associated with the CreateLoadBalancerOptions.SteeringPolicy property. steering policy.

View Source 
const (
	EditLoadBalancerOptions_SessionAffinity_Cookie   = "cookie"
	EditLoadBalancerOptions_SessionAffinity_IpCookie = "ip_cookie"
	EditLoadBalancerOptions_SessionAffinity_None     = "none"
)

Constants associated with the EditLoadBalancerOptions.SessionAffinity property. session affinity.

View Source 
const (
	EditLoadBalancerOptions_SteeringPolicy_DynamicLatency = "dynamic_latency"
	EditLoadBalancerOptions_SteeringPolicy_Geo            = "geo"
	EditLoadBalancerOptions_SteeringPolicy_Off            = "off"
	EditLoadBalancerOptions_SteeringPolicy_Random         = "random"
)

Constants associated with the EditLoadBalancerOptions.SteeringPolicy property. steering policy.

View Source 
const (
	LoadBalancerPack_SessionAffinity_Cookie   = "cookie"
	LoadBalancerPack_SessionAffinity_IpCookie = "ip_cookie"
	LoadBalancerPack_SessionAffinity_None     = "none"
)

Constants associated with the LoadBalancerPack.SessionAffinity property. session affinity.

View Source 
const (
	LoadBalancerPack_SteeringPolicy_DynamicLatency = "dynamic_latency"
	LoadBalancerPack_SteeringPolicy_Geo            = "geo"
	LoadBalancerPack_SteeringPolicy_Off            = "off"
	LoadBalancerPack_SteeringPolicy_Random         = "random"
)

Constants associated with the LoadBalancerPack.SteeringPolicy property. steering policy.

View Source 
const DefaultServiceName = "global_load_balancer"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://api.cis.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func UnmarshalDeleteLoadBalancersResp 

func UnmarshalDeleteLoadBalancersResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteLoadBalancersResp unmarshals an instance of DeleteLoadBalancersResp from the specified map of raw messages.

func UnmarshalDeleteLoadBalancersRespResult 

func UnmarshalDeleteLoadBalancersRespResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteLoadBalancersRespResult unmarshals an instance of DeleteLoadBalancersRespResult from the specified map of raw messages.

func UnmarshalListLoadBalancersResp 

func UnmarshalListLoadBalancersResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListLoadBalancersResp unmarshals an instance of ListLoadBalancersResp from the specified map of raw messages.

func UnmarshalLoadBalancerPack 

func UnmarshalLoadBalancerPack(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLoadBalancerPack unmarshals an instance of LoadBalancerPack from the specified map of raw messages.

func UnmarshalLoadBalancersResp 

func UnmarshalLoadBalancersResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLoadBalancersResp unmarshals an instance of LoadBalancersResp from the specified map of raw messages.

func UnmarshalResultInfo 

func UnmarshalResultInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResultInfo unmarshals an instance of ResultInfo from the specified map of raw messages.

Types

type CreateLoadBalancerOptions 

type CreateLoadBalancerOptions struct {
	// name.
	Name *string `json:"name,omitempty"`

	// fallback pool.
	FallbackPool *string `json:"fallback_pool,omitempty"`

	// default pools.
	DefaultPools []string `json:"default_pools,omitempty"`

	// desc.
	Description *string `json:"description,omitempty"`

	// ttl.
	TTL *int64 `json:"ttl,omitempty"`

	// region pools.
	RegionPools interface{} `json:"region_pools,omitempty"`

	// pop pools.
	PopPools interface{} `json:"pop_pools,omitempty"`

	// proxied.
	Proxied *bool `json:"proxied,omitempty"`

	// enabled/disabled.
	Enabled *bool `json:"enabled,omitempty"`

	// session affinity.
	SessionAffinity *string `json:"session_affinity,omitempty"`

	// steering policy.
	SteeringPolicy *string `json:"steering_policy,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateLoadBalancerOptions : The CreateLoadBalancer options.

func (*CreateLoadBalancerOptions) SetDefaultPools 

func (options *CreateLoadBalancerOptions) SetDefaultPools(defaultPools []string) *CreateLoadBalancerOptions

SetDefaultPools : Allow user to set DefaultPools

func (*CreateLoadBalancerOptions) SetDescription 

func (options *CreateLoadBalancerOptions) SetDescription(description string) *CreateLoadBalancerOptions

SetDescription : Allow user to set Description

func (*CreateLoadBalancerOptions) SetEnabled 

func (options *CreateLoadBalancerOptions) SetEnabled(enabled bool) *CreateLoadBalancerOptions

SetEnabled : Allow user to set Enabled

func (*CreateLoadBalancerOptions) SetFallbackPool 

func (options *CreateLoadBalancerOptions) SetFallbackPool(fallbackPool string) *CreateLoadBalancerOptions

SetFallbackPool : Allow user to set FallbackPool

func (*CreateLoadBalancerOptions) SetHeaders 

func (options *CreateLoadBalancerOptions) SetHeaders(param map[string]string) *CreateLoadBalancerOptions

SetHeaders : Allow user to set Headers

func (*CreateLoadBalancerOptions) SetName 

func (options *CreateLoadBalancerOptions) SetName(name string) *CreateLoadBalancerOptions

SetName : Allow user to set Name

func (*CreateLoadBalancerOptions) SetPopPools 

func (options *CreateLoadBalancerOptions) SetPopPools(popPools interface{}) *CreateLoadBalancerOptions

SetPopPools : Allow user to set PopPools

func (*CreateLoadBalancerOptions) SetProxied 

func (options *CreateLoadBalancerOptions) SetProxied(proxied bool) *CreateLoadBalancerOptions

SetProxied : Allow user to set Proxied

func (*CreateLoadBalancerOptions) SetRegionPools 

func (options *CreateLoadBalancerOptions) SetRegionPools(regionPools interface{}) *CreateLoadBalancerOptions

SetRegionPools : Allow user to set RegionPools

func (*CreateLoadBalancerOptions) SetSessionAffinity 

func (options *CreateLoadBalancerOptions) SetSessionAffinity(sessionAffinity string) *CreateLoadBalancerOptions

SetSessionAffinity : Allow user to set SessionAffinity

func (*CreateLoadBalancerOptions) SetSteeringPolicy 

func (options *CreateLoadBalancerOptions) SetSteeringPolicy(steeringPolicy string) *CreateLoadBalancerOptions

SetSteeringPolicy : Allow user to set SteeringPolicy

func (*CreateLoadBalancerOptions) SetTTL 

func (options *CreateLoadBalancerOptions) SetTTL(ttl int64) *CreateLoadBalancerOptions

SetTTL : Allow user to set TTL

type DeleteLoadBalancerOptions 

type DeleteLoadBalancerOptions struct {
	// load balancer identifier.
	LoadBalancerIdentifier *string `json:"load_balancer_identifier" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteLoadBalancerOptions : The DeleteLoadBalancer options.

func (*DeleteLoadBalancerOptions) SetHeaders 

func (options *DeleteLoadBalancerOptions) SetHeaders(param map[string]string) *DeleteLoadBalancerOptions

SetHeaders : Allow user to set Headers

func (*DeleteLoadBalancerOptions) SetLoadBalancerIdentifier 

func (options *DeleteLoadBalancerOptions) SetLoadBalancerIdentifier(loadBalancerIdentifier string) *DeleteLoadBalancerOptions

SetLoadBalancerIdentifier : Allow user to set LoadBalancerIdentifier

type DeleteLoadBalancersResp 

type DeleteLoadBalancersResp struct {
	// success respose.
	Success *bool `json:"success" validate:"required"`

	// errors.
	Errors [][]string `json:"errors" validate:"required"`

	// messages.
	Messages [][]string `json:"messages" validate:"required"`

	// result.
	Result *DeleteLoadBalancersRespResult `json:"result" validate:"required"`
}

DeleteLoadBalancersResp : delete load balancers response.

type DeleteLoadBalancersRespResult 

type DeleteLoadBalancersRespResult struct {
	// identifier.
	ID *string `json:"id" validate:"required"`
}

DeleteLoadBalancersRespResult : result.

type EditLoadBalancerOptions 

type EditLoadBalancerOptions struct {
	// load balancer identifier.
	LoadBalancerIdentifier *string `json:"load_balancer_identifier" validate:"required"`

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

	// fallback pool.
	FallbackPool *string `json:"fallback_pool,omitempty"`

	// default pools.
	DefaultPools []string `json:"default_pools,omitempty"`

	// desc.
	Description *string `json:"description,omitempty"`

	// ttl.
	TTL *int64 `json:"ttl,omitempty"`

	// region pools.
	RegionPools interface{} `json:"region_pools,omitempty"`

	// pop pools.
	PopPools interface{} `json:"pop_pools,omitempty"`

	// proxied.
	Proxied *bool `json:"proxied,omitempty"`

	// enabled/disabled.
	Enabled *bool `json:"enabled,omitempty"`

	// session affinity.
	SessionAffinity *string `json:"session_affinity,omitempty"`

	// steering policy.
	SteeringPolicy *string `json:"steering_policy,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

EditLoadBalancerOptions : The EditLoadBalancer options.

func (*EditLoadBalancerOptions) SetDefaultPools 

func (options *EditLoadBalancerOptions) SetDefaultPools(defaultPools []string) *EditLoadBalancerOptions

SetDefaultPools : Allow user to set DefaultPools

func (*EditLoadBalancerOptions) SetDescription 

func (options *EditLoadBalancerOptions) SetDescription(description string) *EditLoadBalancerOptions

SetDescription : Allow user to set Description

func (*EditLoadBalancerOptions) SetEnabled 

func (options *EditLoadBalancerOptions) SetEnabled(enabled bool) *EditLoadBalancerOptions

SetEnabled : Allow user to set Enabled

func (*EditLoadBalancerOptions) SetFallbackPool 

func (options *EditLoadBalancerOptions) SetFallbackPool(fallbackPool string) *EditLoadBalancerOptions

SetFallbackPool : Allow user to set FallbackPool

func (*EditLoadBalancerOptions) SetHeaders 

func (options *EditLoadBalancerOptions) SetHeaders(param map[string]string) *EditLoadBalancerOptions

SetHeaders : Allow user to set Headers

func (*EditLoadBalancerOptions) SetLoadBalancerIdentifier 

func (options *EditLoadBalancerOptions) SetLoadBalancerIdentifier(loadBalancerIdentifier string) *EditLoadBalancerOptions

SetLoadBalancerIdentifier : Allow user to set LoadBalancerIdentifier

func (*EditLoadBalancerOptions) SetName 

func (options *EditLoadBalancerOptions) SetName(name string) *EditLoadBalancerOptions

SetName : Allow user to set Name

func (*EditLoadBalancerOptions) SetPopPools 

func (options *EditLoadBalancerOptions) SetPopPools(popPools interface{}) *EditLoadBalancerOptions

SetPopPools : Allow user to set PopPools

func (*EditLoadBalancerOptions) SetProxied 

func (options *EditLoadBalancerOptions) SetProxied(proxied bool) *EditLoadBalancerOptions

SetProxied : Allow user to set Proxied

func (*EditLoadBalancerOptions) SetRegionPools 

func (options *EditLoadBalancerOptions) SetRegionPools(regionPools interface{}) *EditLoadBalancerOptions

SetRegionPools : Allow user to set RegionPools

func (*EditLoadBalancerOptions) SetSessionAffinity 

func (options *EditLoadBalancerOptions) SetSessionAffinity(sessionAffinity string) *EditLoadBalancerOptions

SetSessionAffinity : Allow user to set SessionAffinity

func (*EditLoadBalancerOptions) SetSteeringPolicy 

func (options *EditLoadBalancerOptions) SetSteeringPolicy(steeringPolicy string) *EditLoadBalancerOptions

SetSteeringPolicy : Allow user to set SteeringPolicy

func (*EditLoadBalancerOptions) SetTTL 

func (options *EditLoadBalancerOptions) SetTTL(ttl int64) *EditLoadBalancerOptions

SetTTL : Allow user to set TTL

type GetLoadBalancerSettingsOptions 

type GetLoadBalancerSettingsOptions struct {
	// load balancer identifier.
	LoadBalancerIdentifier *string `json:"load_balancer_identifier" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetLoadBalancerSettingsOptions : The GetLoadBalancerSettings options.

func (*GetLoadBalancerSettingsOptions) SetHeaders 

func (options *GetLoadBalancerSettingsOptions) SetHeaders(param map[string]string) *GetLoadBalancerSettingsOptions

SetHeaders : Allow user to set Headers

func (*GetLoadBalancerSettingsOptions) SetLoadBalancerIdentifier 

func (options *GetLoadBalancerSettingsOptions) SetLoadBalancerIdentifier(loadBalancerIdentifier string) *GetLoadBalancerSettingsOptions

SetLoadBalancerIdentifier : Allow user to set LoadBalancerIdentifier

type GlobalLoadBalancerV1 

type GlobalLoadBalancerV1 struct {
	Service *core.BaseService

	// Full CRN of the service instance.
	Crn *string

	// zone identifier.
	ZoneIdentifier *string
}

GlobalLoadBalancerV1 : Global Load Balancer

Version: 1.0.1

func NewGlobalLoadBalancerV1 

func NewGlobalLoadBalancerV1(options *GlobalLoadBalancerV1Options) (service *GlobalLoadBalancerV1, err error)

NewGlobalLoadBalancerV1 : constructs an instance of GlobalLoadBalancerV1 with passed in options.

func NewGlobalLoadBalancerV1UsingExternalConfig 

func NewGlobalLoadBalancerV1UsingExternalConfig(options *GlobalLoadBalancerV1Options) (globalLoadBalancer *GlobalLoadBalancerV1, err error)

NewGlobalLoadBalancerV1UsingExternalConfig : constructs an instance of GlobalLoadBalancerV1 with passed in options and external configuration.

func (*GlobalLoadBalancerV1) CreateLoadBalancer 

func (globalLoadBalancer *GlobalLoadBalancerV1) CreateLoadBalancer(createLoadBalancerOptions *CreateLoadBalancerOptions) (result *LoadBalancersResp, response *core.DetailedResponse, err error)

CreateLoadBalancer : Create a load balancer Create a load balancer for a given zone. The zone should be active before placing an order of a load balancer.

func (*GlobalLoadBalancerV1) DeleteLoadBalancer 

func (globalLoadBalancer *GlobalLoadBalancerV1) DeleteLoadBalancer(deleteLoadBalancerOptions *DeleteLoadBalancerOptions) (result *DeleteLoadBalancersResp, response *core.DetailedResponse, err error)

DeleteLoadBalancer : Delete a load balancer Delete a load balancer.

func (*GlobalLoadBalancerV1) EditLoadBalancer 

func (globalLoadBalancer *GlobalLoadBalancerV1) EditLoadBalancer(editLoadBalancerOptions *EditLoadBalancerOptions) (result *LoadBalancersResp, response *core.DetailedResponse, err error)

EditLoadBalancer : Edit a load balancer Edit porperties of an existing load balancer.

func (*GlobalLoadBalancerV1) GetLoadBalancerSettings 

func (globalLoadBalancer *GlobalLoadBalancerV1) GetLoadBalancerSettings(getLoadBalancerSettingsOptions *GetLoadBalancerSettingsOptions) (result *LoadBalancersResp, response *core.DetailedResponse, err error)

GetLoadBalancerSettings : Get a load balancer For a given zone identifier and load balancer id, get the load balancer settings.

func (*GlobalLoadBalancerV1) ListAllLoadBalancers 

func (globalLoadBalancer *GlobalLoadBalancerV1) ListAllLoadBalancers(listAllLoadBalancersOptions *ListAllLoadBalancersOptions) (result *ListLoadBalancersResp, response *core.DetailedResponse, err error)

ListAllLoadBalancers : List all load balancers List configured load balancers.

func (*GlobalLoadBalancerV1) NewCreateLoadBalancerOptions 

func (*GlobalLoadBalancerV1) NewCreateLoadBalancerOptions() *CreateLoadBalancerOptions

NewCreateLoadBalancerOptions : Instantiate CreateLoadBalancerOptions

func (*GlobalLoadBalancerV1) NewDeleteLoadBalancerOptions 

func (*GlobalLoadBalancerV1) NewDeleteLoadBalancerOptions(loadBalancerIdentifier string) *DeleteLoadBalancerOptions

NewDeleteLoadBalancerOptions : Instantiate DeleteLoadBalancerOptions

func (*GlobalLoadBalancerV1) NewEditLoadBalancerOptions 

func (*GlobalLoadBalancerV1) NewEditLoadBalancerOptions(loadBalancerIdentifier string) *EditLoadBalancerOptions

NewEditLoadBalancerOptions : Instantiate EditLoadBalancerOptions

func (*GlobalLoadBalancerV1) NewGetLoadBalancerSettingsOptions 

func (*GlobalLoadBalancerV1) NewGetLoadBalancerSettingsOptions(loadBalancerIdentifier string) *GetLoadBalancerSettingsOptions

NewGetLoadBalancerSettingsOptions : Instantiate GetLoadBalancerSettingsOptions

func (*GlobalLoadBalancerV1) NewListAllLoadBalancersOptions 

func (*GlobalLoadBalancerV1) NewListAllLoadBalancersOptions() *ListAllLoadBalancersOptions

NewListAllLoadBalancersOptions : Instantiate ListAllLoadBalancersOptions

func (*GlobalLoadBalancerV1) SetServiceURL 

func (globalLoadBalancer *GlobalLoadBalancerV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type GlobalLoadBalancerV1Options 

type GlobalLoadBalancerV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Full CRN of the service instance.
	Crn *string `validate:"required"`

	// zone identifier.
	ZoneIdentifier *string `validate:"required"`
}

GlobalLoadBalancerV1Options : Service options

type ListAllLoadBalancersOptions 

type ListAllLoadBalancersOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAllLoadBalancersOptions : The ListAllLoadBalancers options.

func (*ListAllLoadBalancersOptions) SetHeaders 

func (options *ListAllLoadBalancersOptions) SetHeaders(param map[string]string) *ListAllLoadBalancersOptions

SetHeaders : Allow user to set Headers

type ListLoadBalancersResp 

type ListLoadBalancersResp struct {
	// success response.
	Success *bool `json:"success" validate:"required"`

	// errors.
	Errors [][]string `json:"errors" validate:"required"`

	// messages.
	Messages [][]string `json:"messages" validate:"required"`

	// result.
	Result []LoadBalancerPack `json:"result" validate:"required"`

	// result information.
	ResultInfo *ResultInfo `json:"result_info" validate:"required"`
}

ListLoadBalancersResp : load balancer list response.

type LoadBalancerPack 

type LoadBalancerPack struct {
	// identifier.
	ID *string `json:"id" validate:"required"`

	// created date.
	CreatedOn *string `json:"created_on" validate:"required"`

	// modified date.
	ModifiedOn *string `json:"modified_on" validate:"required"`

	// desc.
	Description *string `json:"description" validate:"required"`

	// name.
	Name *string `json:"name" validate:"required"`

	// ttl.
	TTL *int64 `json:"ttl" validate:"required"`

	// fallback pool.
	FallbackPool *string `json:"fallback_pool" validate:"required"`

	// default pools.
	DefaultPools []string `json:"default_pools" validate:"required"`

	// region pools.
	RegionPools interface{} `json:"region_pools" validate:"required"`

	// pop pools.
	PopPools interface{} `json:"pop_pools" validate:"required"`

	// proxied.
	Proxied *bool `json:"proxied" validate:"required"`

	// enabled/disabled.
	Enabled *bool `json:"enabled" validate:"required"`

	// session affinity.
	SessionAffinity *string `json:"session_affinity" validate:"required"`

	// steering policy.
	SteeringPolicy *string `json:"steering_policy" validate:"required"`
}

LoadBalancerPack : loadbalancer pack.

type LoadBalancersResp 

type LoadBalancersResp struct {
	// success response.
	Success *bool `json:"success" validate:"required"`

	// errors.
	Errors [][]string `json:"errors" validate:"required"`

	// messages.
	Messages [][]string `json:"messages" validate:"required"`

	// loadbalancer pack.
	Result *LoadBalancerPack `json:"result" validate:"required"`
}

LoadBalancersResp : load balancer response.

type ResultInfo 

type ResultInfo struct {
	// page number.
	Page *int64 `json:"page" validate:"required"`

	// per page count.
	PerPage *int64 `json:"per_page" validate:"required"`

	// count.
	Count *int64 `json:"count" validate:"required"`

	// total count.
	TotalCount *int64 `json:"total_count" validate:"required"`
}

ResultInfo : result information.

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.