Documentation ¶
Overview ¶
Package globalloadbalancereventsv1 : Operations and models for the GlobalLoadBalancerEventsV1 service
Index ¶
- Constants
- func GetServiceURLForRegion(region string) (string, error)
- func UnmarshalListEventsResp(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListEventsRespResultInfo(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListEventsRespResultItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListEventsRespResultItemOriginsItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListEventsRespResultItemPoolItem(m map[string]json.RawMessage, result interface{}) (err error)
- type GetLoadBalancerEventsOptions
- type GlobalLoadBalancerEventsV1
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) Clone() *GlobalLoadBalancerEventsV1
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) DisableRetries()
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) GetEnableGzipCompression() bool
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) GetLoadBalancerEvents(getLoadBalancerEventsOptions *GetLoadBalancerEventsOptions) (result *ListEventsResp, response *core.DetailedResponse, err error)
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) GetLoadBalancerEventsWithContext(ctx context.Context, ...) (result *ListEventsResp, response *core.DetailedResponse, err error)
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) GetServiceURL() string
- func (*GlobalLoadBalancerEventsV1) NewGetLoadBalancerEventsOptions() *GetLoadBalancerEventsOptions
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) SetDefaultHeaders(headers http.Header)
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) SetEnableGzipCompression(enableGzip bool)
- func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) SetServiceURL(url string) error
- type GlobalLoadBalancerEventsV1Options
- type ListEventsResp
- type ListEventsRespResultInfo
- type ListEventsRespResultItem
- type ListEventsRespResultItemOriginsItem
- type ListEventsRespResultItemPoolItem
Constants ¶
const DefaultServiceName = "global_load_balancer_events"
DefaultServiceName is the default key used to find external configuration information.
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 GetServiceURLForRegion ¶ added in v0.12.1
GetServiceURLForRegion returns the service URL to be used for the specified region
func UnmarshalListEventsResp ¶
func UnmarshalListEventsResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListEventsResp unmarshals an instance of ListEventsResp from the specified map of raw messages.
func UnmarshalListEventsRespResultInfo ¶
func UnmarshalListEventsRespResultInfo(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListEventsRespResultInfo unmarshals an instance of ListEventsRespResultInfo from the specified map of raw messages.
func UnmarshalListEventsRespResultItem ¶
func UnmarshalListEventsRespResultItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListEventsRespResultItem unmarshals an instance of ListEventsRespResultItem from the specified map of raw messages.
func UnmarshalListEventsRespResultItemOriginsItem ¶
func UnmarshalListEventsRespResultItemOriginsItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListEventsRespResultItemOriginsItem unmarshals an instance of ListEventsRespResultItemOriginsItem from the specified map of raw messages.
func UnmarshalListEventsRespResultItemPoolItem ¶
func UnmarshalListEventsRespResultItemPoolItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListEventsRespResultItemPoolItem unmarshals an instance of ListEventsRespResultItemPoolItem from the specified map of raw messages.
Types ¶
type GetLoadBalancerEventsOptions ¶
type GetLoadBalancerEventsOptions struct { // Allows users to set headers on API requests Headers map[string]string }
GetLoadBalancerEventsOptions : The GetLoadBalancerEvents options.
func (*GetLoadBalancerEventsOptions) SetHeaders ¶
func (options *GetLoadBalancerEventsOptions) SetHeaders(param map[string]string) *GetLoadBalancerEventsOptions
SetHeaders : Allow user to set Headers
type GlobalLoadBalancerEventsV1 ¶
type GlobalLoadBalancerEventsV1 struct { Service *core.BaseService // Full url-encoded cloud resource name (CRN) of resource instance. Crn *string }
GlobalLoadBalancerEventsV1 : Global Load Balancer Healthcheck Events
Version: 1.0.1
func NewGlobalLoadBalancerEventsV1 ¶
func NewGlobalLoadBalancerEventsV1(options *GlobalLoadBalancerEventsV1Options) (service *GlobalLoadBalancerEventsV1, err error)
NewGlobalLoadBalancerEventsV1 : constructs an instance of GlobalLoadBalancerEventsV1 with passed in options.
func NewGlobalLoadBalancerEventsV1UsingExternalConfig ¶
func NewGlobalLoadBalancerEventsV1UsingExternalConfig(options *GlobalLoadBalancerEventsV1Options) (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1, err error)
NewGlobalLoadBalancerEventsV1UsingExternalConfig : constructs an instance of GlobalLoadBalancerEventsV1 with passed in options and external configuration.
func (*GlobalLoadBalancerEventsV1) Clone ¶ added in v0.12.1
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) Clone() *GlobalLoadBalancerEventsV1
Clone makes a copy of "globalLoadBalancerEvents" suitable for processing requests.
func (*GlobalLoadBalancerEventsV1) DisableRetries ¶ added in v0.12.1
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) DisableRetries()
DisableRetries disables automatic retries for requests invoked for this service instance.
func (*GlobalLoadBalancerEventsV1) EnableRetries ¶ added in v0.12.1
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.
func (*GlobalLoadBalancerEventsV1) GetEnableGzipCompression ¶ added in v0.12.1
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) GetEnableGzipCompression() bool
GetEnableGzipCompression returns the service's EnableGzipCompression field
func (*GlobalLoadBalancerEventsV1) GetLoadBalancerEvents ¶
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) GetLoadBalancerEvents(getLoadBalancerEventsOptions *GetLoadBalancerEventsOptions) (result *ListEventsResp, response *core.DetailedResponse, err error)
GetLoadBalancerEvents : List all load balancer events Get load balancer events for all origins.
func (*GlobalLoadBalancerEventsV1) GetLoadBalancerEventsWithContext ¶ added in v0.12.1
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) GetLoadBalancerEventsWithContext(ctx context.Context, getLoadBalancerEventsOptions *GetLoadBalancerEventsOptions) (result *ListEventsResp, response *core.DetailedResponse, err error)
GetLoadBalancerEventsWithContext is an alternate form of the GetLoadBalancerEvents method which supports a Context parameter
func (*GlobalLoadBalancerEventsV1) GetServiceURL ¶ added in v0.12.1
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) GetServiceURL() string
GetServiceURL returns the service URL
func (*GlobalLoadBalancerEventsV1) NewGetLoadBalancerEventsOptions ¶
func (*GlobalLoadBalancerEventsV1) NewGetLoadBalancerEventsOptions() *GetLoadBalancerEventsOptions
NewGetLoadBalancerEventsOptions : Instantiate GetLoadBalancerEventsOptions
func (*GlobalLoadBalancerEventsV1) SetDefaultHeaders ¶ added in v0.12.1
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) SetDefaultHeaders(headers http.Header)
SetDefaultHeaders sets HTTP headers to be sent in every request
func (*GlobalLoadBalancerEventsV1) SetEnableGzipCompression ¶ added in v0.12.1
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) SetEnableGzipCompression(enableGzip bool)
SetEnableGzipCompression sets the service's EnableGzipCompression field
func (*GlobalLoadBalancerEventsV1) SetServiceURL ¶
func (globalLoadBalancerEvents *GlobalLoadBalancerEventsV1) SetServiceURL(url string) error
SetServiceURL sets the service URL
type GlobalLoadBalancerEventsV1Options ¶
type GlobalLoadBalancerEventsV1Options struct { ServiceName string URL string Authenticator core.Authenticator // Full url-encoded cloud resource name (CRN) of resource instance. Crn *string `validate:"required"` }
GlobalLoadBalancerEventsV1Options : Service options
type ListEventsResp ¶
type ListEventsResp struct { // Was the get successful. Success *bool `json:"success" validate:"required"` // Result of the operation. Result []ListEventsRespResultItem `json:"result" validate:"required"` // result information. ResultInfo *ListEventsRespResultInfo `json:"result_info" validate:"required"` // Array of errors returned. Errors [][]string `json:"errors" validate:"required"` // Array of messages returned. Messages [][]string `json:"messages" validate:"required"` }
ListEventsResp : events list response object.
type ListEventsRespResultInfo ¶
type ListEventsRespResultInfo struct { // Page number. Page *int64 `json:"page" validate:"required"` // Number of results per page. PerPage *int64 `json:"per_page" validate:"required"` // Number of results. Count *int64 `json:"count" validate:"required"` // Total number of results. TotalCount *int64 `json:"total_count" validate:"required"` }
ListEventsRespResultInfo : result information.
type ListEventsRespResultItem ¶
type ListEventsRespResultItem struct { // ID of the event. ID *string `json:"id,omitempty"` // Time of the event. Timestamp *strfmt.DateTime `json:"timestamp,omitempty"` // Pool information. Pool []ListEventsRespResultItemPoolItem `json:"pool,omitempty"` // Load balancer origins. Origins []ListEventsRespResultItemOriginsItem `json:"origins,omitempty"` }
ListEventsRespResultItem : ListEventsRespResultItem struct
type ListEventsRespResultItemOriginsItem ¶
type ListEventsRespResultItemOriginsItem struct { // Origin name. Name *string `json:"name,omitempty"` // Origin address. Address *string `json:"address,omitempty"` // Origin id. Ip *string `json:"ip,omitempty"` // Origin enabled. Enabled *bool `json:"enabled,omitempty"` // Origin healthy. Healthy *bool `json:"healthy,omitempty"` // Origin failure reason. FailureReason *string `json:"failure_reason,omitempty"` // Origin changed. Changed *bool `json:"changed,omitempty"` }
ListEventsRespResultItemOriginsItem : ListEventsRespResultItemOriginsItem struct
type ListEventsRespResultItemPoolItem ¶
type ListEventsRespResultItemPoolItem struct { // Pool id. ID *string `json:"id,omitempty"` // Pool name. Name *string `json:"name,omitempty"` // Pool is healthy. Healthy *bool `json:"healthy,omitempty"` // Pool changed. Changed *bool `json:"changed,omitempty"` // Minimum origins. MinimumOrigins *int64 `json:"minimum_origins,omitempty"` }
ListEventsRespResultItemPoolItem : ListEventsRespResultItemPoolItem struct