globalloadbalancerpoolsv0

package
v0.11.4 Latest Latest
Warning

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

 Go to latest Published: Nov 10, 2020 License: Apache-2.0 Imports: 4 Imported by: 5

Documentation

Overview

Package globalloadbalancerpoolsv0 : Operations and models for the GlobalLoadBalancerPoolsV0 service

Index

Constants

View Source 
const DefaultServiceName = "global_load_balancer_pools"

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 UnmarshalDeleteLoadBalancerPoolResp 

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

UnmarshalDeleteLoadBalancerPoolResp unmarshals an instance of DeleteLoadBalancerPoolResp from the specified map of raw messages.

func UnmarshalDeleteLoadBalancerPoolRespResult 

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

UnmarshalDeleteLoadBalancerPoolRespResult unmarshals an instance of DeleteLoadBalancerPoolRespResult from the specified map of raw messages.

func UnmarshalListLoadBalancerPoolsResp 

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

UnmarshalListLoadBalancerPoolsResp unmarshals an instance of ListLoadBalancerPoolsResp from the specified map of raw messages.

func UnmarshalLoadBalancerPoolPack 

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

UnmarshalLoadBalancerPoolPack unmarshals an instance of LoadBalancerPoolPack from the specified map of raw messages.

func UnmarshalLoadBalancerPoolPackOriginsItem 

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

UnmarshalLoadBalancerPoolPackOriginsItem unmarshals an instance of LoadBalancerPoolPackOriginsItem from the specified map of raw messages.

func UnmarshalLoadBalancerPoolReqOriginsItem 

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

UnmarshalLoadBalancerPoolReqOriginsItem unmarshals an instance of LoadBalancerPoolReqOriginsItem from the specified map of raw messages.

func UnmarshalLoadBalancerPoolResp 

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

UnmarshalLoadBalancerPoolResp unmarshals an instance of LoadBalancerPoolResp 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 CreateLoadBalancerPoolOptions 

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

	// regions check.
	CheckRegions []string `json:"check_regions,omitempty"`

	// origins.
	Origins []LoadBalancerPoolReqOriginsItem `json:"origins,omitempty"`

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

	// The minimum number of origins that must be healthy for this pool to serve traffic.
	MinimumOrigins *int64 `json:"minimum_origins,omitempty"`

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

	// monitor.
	Monitor *string `json:"monitor,omitempty"`

	// notification email.
	NotificationEmail *string `json:"notification_email,omitempty"`

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

CreateLoadBalancerPoolOptions : The CreateLoadBalancerPool options.

func (*CreateLoadBalancerPoolOptions) SetCheckRegions 

func (options *CreateLoadBalancerPoolOptions) SetCheckRegions(checkRegions []string) *CreateLoadBalancerPoolOptions

SetCheckRegions : Allow user to set CheckRegions

func (*CreateLoadBalancerPoolOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*CreateLoadBalancerPoolOptions) SetEnabled 

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

SetEnabled : Allow user to set Enabled

func (*CreateLoadBalancerPoolOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateLoadBalancerPoolOptions) SetMinimumOrigins 

func (options *CreateLoadBalancerPoolOptions) SetMinimumOrigins(minimumOrigins int64) *CreateLoadBalancerPoolOptions

SetMinimumOrigins : Allow user to set MinimumOrigins

func (*CreateLoadBalancerPoolOptions) SetMonitor 

func (options *CreateLoadBalancerPoolOptions) SetMonitor(monitor string) *CreateLoadBalancerPoolOptions

SetMonitor : Allow user to set Monitor

func (*CreateLoadBalancerPoolOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateLoadBalancerPoolOptions) SetNotificationEmail 

func (options *CreateLoadBalancerPoolOptions) SetNotificationEmail(notificationEmail string) *CreateLoadBalancerPoolOptions

SetNotificationEmail : Allow user to set NotificationEmail

func (*CreateLoadBalancerPoolOptions) SetOrigins 

func (options *CreateLoadBalancerPoolOptions) SetOrigins(origins []LoadBalancerPoolReqOriginsItem) *CreateLoadBalancerPoolOptions

SetOrigins : Allow user to set Origins

type DeleteLoadBalancerPoolOptions 

type DeleteLoadBalancerPoolOptions struct {
	// pool identifier.
	PoolIdentifier *string `json:"pool_identifier" validate:"required"`

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

DeleteLoadBalancerPoolOptions : The DeleteLoadBalancerPool options.

func (*DeleteLoadBalancerPoolOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteLoadBalancerPoolOptions) SetPoolIdentifier 

func (options *DeleteLoadBalancerPoolOptions) SetPoolIdentifier(poolIdentifier string) *DeleteLoadBalancerPoolOptions

SetPoolIdentifier : Allow user to set PoolIdentifier

type DeleteLoadBalancerPoolResp 

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

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

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

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

DeleteLoadBalancerPoolResp : load balancer pool delete response.

type DeleteLoadBalancerPoolRespResult 

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

DeleteLoadBalancerPoolRespResult : result.

type EditLoadBalancerPoolOptions 

type EditLoadBalancerPoolOptions struct {
	// pool identifier.
	PoolIdentifier *string `json:"pool_identifier" validate:"required"`

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

	// regions check.
	CheckRegions []string `json:"check_regions,omitempty"`

	// origins.
	Origins []LoadBalancerPoolReqOriginsItem `json:"origins,omitempty"`

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

	// The minimum number of origins that must be healthy for this pool to serve traffic.
	MinimumOrigins *int64 `json:"minimum_origins,omitempty"`

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

	// monitor.
	Monitor *string `json:"monitor,omitempty"`

	// notification email.
	NotificationEmail *string `json:"notification_email,omitempty"`

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

EditLoadBalancerPoolOptions : The EditLoadBalancerPool options.

func (*EditLoadBalancerPoolOptions) SetCheckRegions 

func (options *EditLoadBalancerPoolOptions) SetCheckRegions(checkRegions []string) *EditLoadBalancerPoolOptions

SetCheckRegions : Allow user to set CheckRegions

func (*EditLoadBalancerPoolOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*EditLoadBalancerPoolOptions) SetEnabled 

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

SetEnabled : Allow user to set Enabled

func (*EditLoadBalancerPoolOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*EditLoadBalancerPoolOptions) SetMinimumOrigins 

func (options *EditLoadBalancerPoolOptions) SetMinimumOrigins(minimumOrigins int64) *EditLoadBalancerPoolOptions

SetMinimumOrigins : Allow user to set MinimumOrigins

func (*EditLoadBalancerPoolOptions) SetMonitor 

func (options *EditLoadBalancerPoolOptions) SetMonitor(monitor string) *EditLoadBalancerPoolOptions

SetMonitor : Allow user to set Monitor

func (*EditLoadBalancerPoolOptions) SetName 

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

SetName : Allow user to set Name

func (*EditLoadBalancerPoolOptions) SetNotificationEmail 

func (options *EditLoadBalancerPoolOptions) SetNotificationEmail(notificationEmail string) *EditLoadBalancerPoolOptions

SetNotificationEmail : Allow user to set NotificationEmail

func (*EditLoadBalancerPoolOptions) SetOrigins 

func (options *EditLoadBalancerPoolOptions) SetOrigins(origins []LoadBalancerPoolReqOriginsItem) *EditLoadBalancerPoolOptions

SetOrigins : Allow user to set Origins

func (*EditLoadBalancerPoolOptions) SetPoolIdentifier 

func (options *EditLoadBalancerPoolOptions) SetPoolIdentifier(poolIdentifier string) *EditLoadBalancerPoolOptions

SetPoolIdentifier : Allow user to set PoolIdentifier

type GetLoadBalancerPoolOptions 

type GetLoadBalancerPoolOptions struct {
	// pool identifier.
	PoolIdentifier *string `json:"pool_identifier" validate:"required"`

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

GetLoadBalancerPoolOptions : The GetLoadBalancerPool options.

func (*GetLoadBalancerPoolOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetLoadBalancerPoolOptions) SetPoolIdentifier 

func (options *GetLoadBalancerPoolOptions) SetPoolIdentifier(poolIdentifier string) *GetLoadBalancerPoolOptions

SetPoolIdentifier : Allow user to set PoolIdentifier

type GlobalLoadBalancerPoolsV0 

type GlobalLoadBalancerPoolsV0 struct {
	Service *core.BaseService

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

GlobalLoadBalancerPoolsV0 : GLB Pools

Version: 0.0.1

func NewGlobalLoadBalancerPoolsV0 

func NewGlobalLoadBalancerPoolsV0(options *GlobalLoadBalancerPoolsV0Options) (service *GlobalLoadBalancerPoolsV0, err error)

NewGlobalLoadBalancerPoolsV0 : constructs an instance of GlobalLoadBalancerPoolsV0 with passed in options.

func NewGlobalLoadBalancerPoolsV0UsingExternalConfig 

func NewGlobalLoadBalancerPoolsV0UsingExternalConfig(options *GlobalLoadBalancerPoolsV0Options) (globalLoadBalancerPools *GlobalLoadBalancerPoolsV0, err error)

NewGlobalLoadBalancerPoolsV0UsingExternalConfig : constructs an instance of GlobalLoadBalancerPoolsV0 with passed in options and external configuration.

func (*GlobalLoadBalancerPoolsV0) CreateLoadBalancerPool 

func (globalLoadBalancerPools *GlobalLoadBalancerPoolsV0) CreateLoadBalancerPool(createLoadBalancerPoolOptions *CreateLoadBalancerPoolOptions) (result *LoadBalancerPoolResp, response *core.DetailedResponse, err error)

CreateLoadBalancerPool : Create pool Create a new load balancer pool.

func (*GlobalLoadBalancerPoolsV0) DeleteLoadBalancerPool 

func (globalLoadBalancerPools *GlobalLoadBalancerPoolsV0) DeleteLoadBalancerPool(deleteLoadBalancerPoolOptions *DeleteLoadBalancerPoolOptions) (result *DeleteLoadBalancerPoolResp, response *core.DetailedResponse, err error)

DeleteLoadBalancerPool : Delete pool Delete a specific configured load balancer pool.

func (*GlobalLoadBalancerPoolsV0) EditLoadBalancerPool 

func (globalLoadBalancerPools *GlobalLoadBalancerPoolsV0) EditLoadBalancerPool(editLoadBalancerPoolOptions *EditLoadBalancerPoolOptions) (result *LoadBalancerPoolResp, response *core.DetailedResponse, err error)

EditLoadBalancerPool : Edit pool Edit a specific configured load balancer pool.

func (*GlobalLoadBalancerPoolsV0) GetLoadBalancerPool 

func (globalLoadBalancerPools *GlobalLoadBalancerPoolsV0) GetLoadBalancerPool(getLoadBalancerPoolOptions *GetLoadBalancerPoolOptions) (result *LoadBalancerPoolResp, response *core.DetailedResponse, err error)

GetLoadBalancerPool : Get pool Get a single configured load balancer pool.

func (*GlobalLoadBalancerPoolsV0) ListAllLoadBalancerPools 

func (globalLoadBalancerPools *GlobalLoadBalancerPoolsV0) ListAllLoadBalancerPools(listAllLoadBalancerPoolsOptions *ListAllLoadBalancerPoolsOptions) (result *ListLoadBalancerPoolsResp, response *core.DetailedResponse, err error)

ListAllLoadBalancerPools : List all pools List all configured load balancer pools.

func (*GlobalLoadBalancerPoolsV0) NewCreateLoadBalancerPoolOptions 

func (*GlobalLoadBalancerPoolsV0) NewCreateLoadBalancerPoolOptions() *CreateLoadBalancerPoolOptions

NewCreateLoadBalancerPoolOptions : Instantiate CreateLoadBalancerPoolOptions

func (*GlobalLoadBalancerPoolsV0) NewDeleteLoadBalancerPoolOptions 

func (*GlobalLoadBalancerPoolsV0) NewDeleteLoadBalancerPoolOptions(poolIdentifier string) *DeleteLoadBalancerPoolOptions

NewDeleteLoadBalancerPoolOptions : Instantiate DeleteLoadBalancerPoolOptions

func (*GlobalLoadBalancerPoolsV0) NewEditLoadBalancerPoolOptions 

func (*GlobalLoadBalancerPoolsV0) NewEditLoadBalancerPoolOptions(poolIdentifier string) *EditLoadBalancerPoolOptions

NewEditLoadBalancerPoolOptions : Instantiate EditLoadBalancerPoolOptions

func (*GlobalLoadBalancerPoolsV0) NewGetLoadBalancerPoolOptions 

func (*GlobalLoadBalancerPoolsV0) NewGetLoadBalancerPoolOptions(poolIdentifier string) *GetLoadBalancerPoolOptions

NewGetLoadBalancerPoolOptions : Instantiate GetLoadBalancerPoolOptions

func (*GlobalLoadBalancerPoolsV0) NewListAllLoadBalancerPoolsOptions 

func (*GlobalLoadBalancerPoolsV0) NewListAllLoadBalancerPoolsOptions() *ListAllLoadBalancerPoolsOptions

NewListAllLoadBalancerPoolsOptions : Instantiate ListAllLoadBalancerPoolsOptions

func (*GlobalLoadBalancerPoolsV0) SetServiceURL 

func (globalLoadBalancerPools *GlobalLoadBalancerPoolsV0) SetServiceURL(url string) error

SetServiceURL sets the service URL

type GlobalLoadBalancerPoolsV0Options 

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

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

GlobalLoadBalancerPoolsV0Options : Service options

type ListAllLoadBalancerPoolsOptions 

type ListAllLoadBalancerPoolsOptions struct {

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

ListAllLoadBalancerPoolsOptions : The ListAllLoadBalancerPools options.

func (*ListAllLoadBalancerPoolsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

type ListLoadBalancerPoolsResp 

type ListLoadBalancerPoolsResp 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 []LoadBalancerPoolPack `json:"result" validate:"required"`

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

ListLoadBalancerPoolsResp : list load balancer pools response.

type LoadBalancerPoolPack 

type LoadBalancerPoolPack struct {
	// identifier.
	ID *string `json:"id,omitempty"`

	// created date.
	CreatedOn *string `json:"created_on,omitempty"`

	// modified date.
	ModifiedOn *string `json:"modified_on,omitempty"`

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

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

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

	// healthy.
	Healthy *bool `json:"healthy,omitempty"`

	// monitor.
	Monitor *string `json:"monitor,omitempty"`

	// Minimum origin count.
	MinimumOrigins *int64 `json:"minimum_origins,omitempty"`

	// regions check.
	CheckRegions []string `json:"check_regions,omitempty"`

	// original.
	Origins []LoadBalancerPoolPackOriginsItem `json:"origins" validate:"required"`

	// notification email.
	NotificationEmail *string `json:"notification_email,omitempty"`
}

LoadBalancerPoolPack : load balancer pool pack.

type LoadBalancerPoolPackOriginsItem 

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

	// address.
	Address *string `json:"address,omitempty"`

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

	// healthy.
	Healthy *bool `json:"healthy,omitempty"`

	// weight.
	Weight *float64 `json:"weight,omitempty"`

	// Pool origin disabled date.
	DisabledAt *string `json:"disabled_at,omitempty"`

	// Reason for failure.
	FailureReason *string `json:"failure_reason,omitempty"`
}

LoadBalancerPoolPackOriginsItem : LoadBalancerPoolPackOriginsItem struct

type LoadBalancerPoolReqOriginsItem 

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

	// address.
	Address *string `json:"address,omitempty"`

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

	// weight.
	Weight *float64 `json:"weight,omitempty"`
}

LoadBalancerPoolReqOriginsItem : items.

type LoadBalancerPoolResp 

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

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

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

	// load balancer pool pack.
	Result *LoadBalancerPoolPack `json:"result" validate:"required"`

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

LoadBalancerPoolResp : get load balancer pool 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.