globalloadbalancersv1

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: 5 Imported by: 0

Documentation

Overview

Package globalloadbalancersv1 : Operations and models for the GlobalLoadBalancersV1 service Deprecated: This module is deprecated. For more detail https://github.com/IBM/networking-go-sdk/blob/master/DEPRECATION-NOTICE.md

Index

Constants

View Source 
const (
	CreateMonitorOptions_Type_Http  = "HTTP"
	CreateMonitorOptions_Type_Https = "HTTPS"
	CreateMonitorOptions_Type_Tcp   = "TCP"
)

Constants associated with the CreateMonitorOptions.Type property. The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.

View Source 
const (
	CreateMonitorOptions_Method_Get  = "GET"
	CreateMonitorOptions_Method_Head = "HEAD"
)

Constants associated with the CreateMonitorOptions.Method property. The method to use for the health check applicable to HTTP/HTTPS based checks, the default value is 'GET'.

View Source 
const (
	CreatePoolOptions_HealthcheckRegion_AuSyd   = "au-syd"
	CreatePoolOptions_HealthcheckRegion_EuDu    = "eu-du"
	CreatePoolOptions_HealthcheckRegion_EuGb    = "eu-gb"
	CreatePoolOptions_HealthcheckRegion_JpTok   = "jp-tok"
	CreatePoolOptions_HealthcheckRegion_UsEast  = "us-east"
	CreatePoolOptions_HealthcheckRegion_UsSouth = "us-south"
)

Constants associated with the CreatePoolOptions.HealthcheckRegion property. Health check region of VSIs.

View Source 
const (
	UpdateMonitorOptions_Type_Http  = "HTTP"
	UpdateMonitorOptions_Type_Https = "HTTPS"
	UpdateMonitorOptions_Type_Tcp   = "TCP"
)

Constants associated with the UpdateMonitorOptions.Type property. The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.

View Source 
const (
	UpdateMonitorOptions_Method_Get  = "GET"
	UpdateMonitorOptions_Method_Head = "HEAD"
)

Constants associated with the UpdateMonitorOptions.Method property. The method to use for the health check applicable to HTTP/HTTPS based checks, the default value is 'GET'.

View Source 
const (
	UpdatePoolOptions_HealthcheckRegion_AuSyd   = "au-syd"
	UpdatePoolOptions_HealthcheckRegion_EuDu    = "eu-du"
	UpdatePoolOptions_HealthcheckRegion_EuGb    = "eu-gb"
	UpdatePoolOptions_HealthcheckRegion_JpTok   = "jp-tok"
	UpdatePoolOptions_HealthcheckRegion_UsEast  = "us-east"
	UpdatePoolOptions_HealthcheckRegion_UsSouth = "us-south"
)

Constants associated with the UpdatePoolOptions.HealthcheckRegion property. Health check region of VSIs.

View Source 
const (
	LoadBalancer_Health_Critical = "CRITICAL"
	LoadBalancer_Health_Degraded = "DEGRADED"
	LoadBalancer_Health_Healthy  = "HEALTHY"
)

Constants associated with the LoadBalancer.Health property. Healthy state of the load balancer.

View Source 
const (
	Monitor_Method_Get  = "GET"
	Monitor_Method_Head = "HEAD"
)

Constants associated with the Monitor.Method property. The method to use for the health check applicable to HTTP/HTTPS based checks, the default value is 'GET'.

View Source 
const (
	Pool_Health_Critical = "CRITICAL"
	Pool_Health_Degraded = "DEGRADED"
	Pool_Health_Healthy  = "HEALTHY"
)

Constants associated with the Pool.Health property. Healthy state of the load balancer pool.

View Source 
const (
	Pool_HealthcheckRegion_AuSyd   = "au-syd"
	Pool_HealthcheckRegion_EuDu    = "eu-du"
	Pool_HealthcheckRegion_EuGb    = "eu-gb"
	Pool_HealthcheckRegion_JpTok   = "jp-tok"
	Pool_HealthcheckRegion_UsEast  = "us-east"
	Pool_HealthcheckRegion_UsSouth = "us-south"
)

Constants associated with the Pool.HealthcheckRegion property. Health check region of VSIs.

View Source 
const DefaultServiceName = "global_load_balancers"

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

View Source 
const DefaultServiceURL = "https://api.dns-svcs.cloud.ibm.com/v1"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func UnmarshalFirstHref 

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

UnmarshalFirstHref unmarshals an instance of FirstHref from the specified map of raw messages.

func UnmarshalHealthcheckHeader 

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

UnmarshalHealthcheckHeader unmarshals an instance of HealthcheckHeader from the specified map of raw messages.

func UnmarshalListLoadBalancers 

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

UnmarshalListLoadBalancers unmarshals an instance of ListLoadBalancers from the specified map of raw messages.

func UnmarshalListMonitors 

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

UnmarshalListMonitors unmarshals an instance of ListMonitors from the specified map of raw messages.

func UnmarshalListPools 

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

UnmarshalListPools unmarshals an instance of ListPools from the specified map of raw messages.

func UnmarshalLoadBalancer 

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

UnmarshalLoadBalancer unmarshals an instance of LoadBalancer from the specified map of raw messages.

func UnmarshalLoadBalancerAzPoolsItem 

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

UnmarshalLoadBalancerAzPoolsItem unmarshals an instance of LoadBalancerAzPoolsItem from the specified map of raw messages.

func UnmarshalMonitor 

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

UnmarshalMonitor unmarshals an instance of Monitor from the specified map of raw messages.

func UnmarshalNextHref 

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

UnmarshalNextHref unmarshals an instance of NextHref from the specified map of raw messages.

func UnmarshalOrigin 

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

UnmarshalOrigin unmarshals an instance of Origin from the specified map of raw messages.

func UnmarshalOriginInput 

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

UnmarshalOriginInput unmarshals an instance of OriginInput from the specified map of raw messages.

func UnmarshalPool 

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

UnmarshalPool unmarshals an instance of Pool from the specified map of raw messages.

Types

type CreateLoadBalancerOptions 

type CreateLoadBalancerOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a DNS zone.
	DnszoneID *string `json:"dnszone_id" validate:"required"`

	// Name of the load balancer.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer.
	Description *string `json:"description,omitempty"`

	// Whether the load balancer is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Time to live in second.
	TTL *int64 `json:"ttl,omitempty"`

	// The pool ID to use when all other pools are detected as unhealthy.
	FallbackPool *string `json:"fallback_pool,omitempty"`

	// A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools
	// are not configured for a given region.
	DefaultPools []string `json:"default_pools,omitempty"`

	// Map availability zones to pool ID's.
	AzPools []LoadBalancerAzPoolsItem `json:"az_pools,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

CreateLoadBalancerOptions : The CreateLoadBalancer options.

func (*CreateLoadBalancerOptions) SetAzPools 

func (options *CreateLoadBalancerOptions) SetAzPools(azPools []LoadBalancerAzPoolsItem) *CreateLoadBalancerOptions

SetAzPools : Allow user to set AzPools

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) SetDnszoneID 

func (options *CreateLoadBalancerOptions) SetDnszoneID(dnszoneID string) *CreateLoadBalancerOptions

SetDnszoneID : Allow user to set DnszoneID

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) SetInstanceID 

func (options *CreateLoadBalancerOptions) SetInstanceID(instanceID string) *CreateLoadBalancerOptions

SetInstanceID : Allow user to set InstanceID

func (*CreateLoadBalancerOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateLoadBalancerOptions) SetTTL 

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

SetTTL : Allow user to set TTL

func (*CreateLoadBalancerOptions) SetXCorrelationID 

func (options *CreateLoadBalancerOptions) SetXCorrelationID(xCorrelationID string) *CreateLoadBalancerOptions

SetXCorrelationID : Allow user to set XCorrelationID

type CreateMonitorOptions 

type CreateMonitorOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The name of the load balancer monitor.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer monitor.
	Description *string `json:"description,omitempty"`

	// The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
	Type *string `json:"type,omitempty"`

	// Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define
	// the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
	Port *int64 `json:"port,omitempty"`

	// The interval between each health check. Shorter intervals may improve failover time, but will increase load on the
	// origins as we check from multiple locations.
	Interval *int64 `json:"interval,omitempty"`

	// The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted
	// immediately.
	Retries *int64 `json:"retries,omitempty"`

	// The timeout (in seconds) before marking the health check as failed.
	Timeout *int64 `json:"timeout,omitempty"`

	// The method to use for the health check applicable to HTTP/HTTPS based checks, the default value is 'GET'.
	Method *string `json:"method,omitempty"`

	// The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
	Path *string `json:"path,omitempty"`

	// The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The
	// User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
	HeadersVar []HealthcheckHeader `json:"headers,omitempty"`

	// Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
	AllowInsecure *bool `json:"allow_insecure,omitempty"`

	// The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS
	// monitors.
	ExpectedCodes *string `json:"expected_codes,omitempty"`

	// A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be
	// marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
	ExpectedBody *string `json:"expected_body,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

CreateMonitorOptions : The CreateMonitor options.

func (*CreateMonitorOptions) SetAllowInsecure 

func (options *CreateMonitorOptions) SetAllowInsecure(allowInsecure bool) *CreateMonitorOptions

SetAllowInsecure : Allow user to set AllowInsecure

func (*CreateMonitorOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*CreateMonitorOptions) SetExpectedBody 

func (options *CreateMonitorOptions) SetExpectedBody(expectedBody string) *CreateMonitorOptions

SetExpectedBody : Allow user to set ExpectedBody

func (*CreateMonitorOptions) SetExpectedCodes 

func (options *CreateMonitorOptions) SetExpectedCodes(expectedCodes string) *CreateMonitorOptions

SetExpectedCodes : Allow user to set ExpectedCodes

func (*CreateMonitorOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateMonitorOptions) SetHeadersVar 

func (options *CreateMonitorOptions) SetHeadersVar(headersVar []HealthcheckHeader) *CreateMonitorOptions

SetHeadersVar : Allow user to set HeadersVar

func (*CreateMonitorOptions) SetInstanceID 

func (options *CreateMonitorOptions) SetInstanceID(instanceID string) *CreateMonitorOptions

SetInstanceID : Allow user to set InstanceID

func (*CreateMonitorOptions) SetInterval 

func (options *CreateMonitorOptions) SetInterval(interval int64) *CreateMonitorOptions

SetInterval : Allow user to set Interval

func (*CreateMonitorOptions) SetMethod 

func (options *CreateMonitorOptions) SetMethod(method string) *CreateMonitorOptions

SetMethod : Allow user to set Method

func (*CreateMonitorOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateMonitorOptions) SetPath 

func (options *CreateMonitorOptions) SetPath(path string) *CreateMonitorOptions

SetPath : Allow user to set Path

func (*CreateMonitorOptions) SetPort 

func (options *CreateMonitorOptions) SetPort(port int64) *CreateMonitorOptions

SetPort : Allow user to set Port

func (*CreateMonitorOptions) SetRetries 

func (options *CreateMonitorOptions) SetRetries(retries int64) *CreateMonitorOptions

SetRetries : Allow user to set Retries

func (*CreateMonitorOptions) SetTimeout 

func (options *CreateMonitorOptions) SetTimeout(timeout int64) *CreateMonitorOptions

SetTimeout : Allow user to set Timeout

func (*CreateMonitorOptions) SetType 

func (options *CreateMonitorOptions) SetType(typeVar string) *CreateMonitorOptions

SetType : Allow user to set Type

func (*CreateMonitorOptions) SetXCorrelationID 

func (options *CreateMonitorOptions) SetXCorrelationID(xCorrelationID string) *CreateMonitorOptions

SetXCorrelationID : Allow user to set XCorrelationID

type CreatePoolOptions 

type CreatePoolOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// Name of the load balancer pool.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer pool.
	Description *string `json:"description,omitempty"`

	// Whether the load balancer pool is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins
	// falls below this number, the pool will be marked unhealthy and we will failover to the next available pool.
	HealthyOriginsThreshold *int64 `json:"healthy_origins_threshold,omitempty"`

	// The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy
	// origins, provided the pool itself is healthy.
	Origins []OriginInput `json:"origins,omitempty"`

	// The ID of the load balancer monitor to be associated to this pool.
	Monitor *string `json:"monitor,omitempty"`

	// The notification channel.
	NotificationChannel *string `json:"notification_channel,omitempty"`

	// Health check region of VSIs.
	HealthcheckRegion *string `json:"healthcheck_region,omitempty"`

	// Health check subnet IDs of VSIs.
	HealthcheckSubnets []string `json:"healthcheck_subnets,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

CreatePoolOptions : The CreatePool options.

func (*CreatePoolOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*CreatePoolOptions) SetEnabled 

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

SetEnabled : Allow user to set Enabled

func (*CreatePoolOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreatePoolOptions) SetHealthcheckRegion 

func (options *CreatePoolOptions) SetHealthcheckRegion(healthcheckRegion string) *CreatePoolOptions

SetHealthcheckRegion : Allow user to set HealthcheckRegion

func (*CreatePoolOptions) SetHealthcheckSubnets 

func (options *CreatePoolOptions) SetHealthcheckSubnets(healthcheckSubnets []string) *CreatePoolOptions

SetHealthcheckSubnets : Allow user to set HealthcheckSubnets

func (*CreatePoolOptions) SetHealthyOriginsThreshold 

func (options *CreatePoolOptions) SetHealthyOriginsThreshold(healthyOriginsThreshold int64) *CreatePoolOptions

SetHealthyOriginsThreshold : Allow user to set HealthyOriginsThreshold

func (*CreatePoolOptions) SetInstanceID 

func (options *CreatePoolOptions) SetInstanceID(instanceID string) *CreatePoolOptions

SetInstanceID : Allow user to set InstanceID

func (*CreatePoolOptions) SetMonitor 

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

SetMonitor : Allow user to set Monitor

func (*CreatePoolOptions) SetName 

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

SetName : Allow user to set Name

func (*CreatePoolOptions) SetNotificationChannel 

func (options *CreatePoolOptions) SetNotificationChannel(notificationChannel string) *CreatePoolOptions

SetNotificationChannel : Allow user to set NotificationChannel

func (*CreatePoolOptions) SetOrigins 

func (options *CreatePoolOptions) SetOrigins(origins []OriginInput) *CreatePoolOptions

SetOrigins : Allow user to set Origins

func (*CreatePoolOptions) SetXCorrelationID 

func (options *CreatePoolOptions) SetXCorrelationID(xCorrelationID string) *CreatePoolOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DeleteLoadBalancerOptions 

type DeleteLoadBalancerOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a DNS zone.
	DnszoneID *string `json:"dnszone_id" validate:"required"`

	// The unique identifier of a load balancer.
	LbID *string `json:"lb_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

DeleteLoadBalancerOptions : The DeleteLoadBalancer options.

func (*DeleteLoadBalancerOptions) SetDnszoneID 

func (options *DeleteLoadBalancerOptions) SetDnszoneID(dnszoneID string) *DeleteLoadBalancerOptions

SetDnszoneID : Allow user to set DnszoneID

func (*DeleteLoadBalancerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteLoadBalancerOptions) SetInstanceID 

func (options *DeleteLoadBalancerOptions) SetInstanceID(instanceID string) *DeleteLoadBalancerOptions

SetInstanceID : Allow user to set InstanceID

func (*DeleteLoadBalancerOptions) SetLbID 

func (options *DeleteLoadBalancerOptions) SetLbID(lbID string) *DeleteLoadBalancerOptions

SetLbID : Allow user to set LbID

func (*DeleteLoadBalancerOptions) SetXCorrelationID 

func (options *DeleteLoadBalancerOptions) SetXCorrelationID(xCorrelationID string) *DeleteLoadBalancerOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DeleteMonitorOptions 

type DeleteMonitorOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a load balancer monitor.
	MonitorID *string `json:"monitor_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

DeleteMonitorOptions : The DeleteMonitor options.

func (*DeleteMonitorOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteMonitorOptions) SetInstanceID 

func (options *DeleteMonitorOptions) SetInstanceID(instanceID string) *DeleteMonitorOptions

SetInstanceID : Allow user to set InstanceID

func (*DeleteMonitorOptions) SetMonitorID 

func (options *DeleteMonitorOptions) SetMonitorID(monitorID string) *DeleteMonitorOptions

SetMonitorID : Allow user to set MonitorID

func (*DeleteMonitorOptions) SetXCorrelationID 

func (options *DeleteMonitorOptions) SetXCorrelationID(xCorrelationID string) *DeleteMonitorOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DeletePoolOptions 

type DeletePoolOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a load balancer pool.
	PoolID *string `json:"pool_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

DeletePoolOptions : The DeletePool options.

func (*DeletePoolOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeletePoolOptions) SetInstanceID 

func (options *DeletePoolOptions) SetInstanceID(instanceID string) *DeletePoolOptions

SetInstanceID : Allow user to set InstanceID

func (*DeletePoolOptions) SetPoolID 

func (options *DeletePoolOptions) SetPoolID(poolID string) *DeletePoolOptions

SetPoolID : Allow user to set PoolID

func (*DeletePoolOptions) SetXCorrelationID 

func (options *DeletePoolOptions) SetXCorrelationID(xCorrelationID string) *DeletePoolOptions

SetXCorrelationID : Allow user to set XCorrelationID

type FirstHref 

type FirstHref struct {
	// href.
	Href *string `json:"href,omitempty"`
}

FirstHref : href.

type GetLoadBalancerOptions 

type GetLoadBalancerOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a DNS zone.
	DnszoneID *string `json:"dnszone_id" validate:"required"`

	// The unique identifier of a load balancer.
	LbID *string `json:"lb_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

GetLoadBalancerOptions : The GetLoadBalancer options.

func (*GetLoadBalancerOptions) SetDnszoneID 

func (options *GetLoadBalancerOptions) SetDnszoneID(dnszoneID string) *GetLoadBalancerOptions

SetDnszoneID : Allow user to set DnszoneID

func (*GetLoadBalancerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetLoadBalancerOptions) SetInstanceID 

func (options *GetLoadBalancerOptions) SetInstanceID(instanceID string) *GetLoadBalancerOptions

SetInstanceID : Allow user to set InstanceID

func (*GetLoadBalancerOptions) SetLbID 

func (options *GetLoadBalancerOptions) SetLbID(lbID string) *GetLoadBalancerOptions

SetLbID : Allow user to set LbID

func (*GetLoadBalancerOptions) SetXCorrelationID 

func (options *GetLoadBalancerOptions) SetXCorrelationID(xCorrelationID string) *GetLoadBalancerOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetMonitorOptions 

type GetMonitorOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a load balancer monitor.
	MonitorID *string `json:"monitor_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

GetMonitorOptions : The GetMonitor options.

func (*GetMonitorOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetMonitorOptions) SetInstanceID 

func (options *GetMonitorOptions) SetInstanceID(instanceID string) *GetMonitorOptions

SetInstanceID : Allow user to set InstanceID

func (*GetMonitorOptions) SetMonitorID 

func (options *GetMonitorOptions) SetMonitorID(monitorID string) *GetMonitorOptions

SetMonitorID : Allow user to set MonitorID

func (*GetMonitorOptions) SetXCorrelationID 

func (options *GetMonitorOptions) SetXCorrelationID(xCorrelationID string) *GetMonitorOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetPoolOptions 

type GetPoolOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a load balancer pool.
	PoolID *string `json:"pool_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

GetPoolOptions : The GetPool options.

func (*GetPoolOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetPoolOptions) SetInstanceID 

func (options *GetPoolOptions) SetInstanceID(instanceID string) *GetPoolOptions

SetInstanceID : Allow user to set InstanceID

func (*GetPoolOptions) SetPoolID 

func (options *GetPoolOptions) SetPoolID(poolID string) *GetPoolOptions

SetPoolID : Allow user to set PoolID

func (*GetPoolOptions) SetXCorrelationID 

func (options *GetPoolOptions) SetXCorrelationID(xCorrelationID string) *GetPoolOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GlobalLoadBalancersV1 

type GlobalLoadBalancersV1 struct {
	Service *core.BaseService
}

GlobalLoadBalancersV1 : Global Load Balancers

Version: 1.0.0

func NewGlobalLoadBalancersV1 

func NewGlobalLoadBalancersV1(options *GlobalLoadBalancersV1Options) (service *GlobalLoadBalancersV1, err error)

NewGlobalLoadBalancersV1 : constructs an instance of GlobalLoadBalancersV1 with passed in options.

func NewGlobalLoadBalancersV1UsingExternalConfig 

func NewGlobalLoadBalancersV1UsingExternalConfig(options *GlobalLoadBalancersV1Options) (globalLoadBalancers *GlobalLoadBalancersV1, err error)

NewGlobalLoadBalancersV1UsingExternalConfig : constructs an instance of GlobalLoadBalancersV1 with passed in options and external configuration.

func (*GlobalLoadBalancersV1) CreateLoadBalancer 

func (globalLoadBalancers *GlobalLoadBalancersV1) CreateLoadBalancer(createLoadBalancerOptions *CreateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)

CreateLoadBalancer : Create a load balancer Create a load balancer for a given DNS zone.

func (*GlobalLoadBalancersV1) CreateMonitor 

func (globalLoadBalancers *GlobalLoadBalancersV1) CreateMonitor(createMonitorOptions *CreateMonitorOptions) (result *Monitor, response *core.DetailedResponse, err error)

CreateMonitor : Create a load balancer monitor Create a load balancer monitor.

func (*GlobalLoadBalancersV1) CreatePool 

func (globalLoadBalancers *GlobalLoadBalancersV1) CreatePool(createPoolOptions *CreatePoolOptions) (result *Pool, response *core.DetailedResponse, err error)

CreatePool : Create a load balancer pool Create a load balancer pool.

func (*GlobalLoadBalancersV1) DeleteLoadBalancer 

func (globalLoadBalancers *GlobalLoadBalancersV1) DeleteLoadBalancer(deleteLoadBalancerOptions *DeleteLoadBalancerOptions) (response *core.DetailedResponse, err error)

DeleteLoadBalancer : Delete a load balancer Delete a load balancer.

func (*GlobalLoadBalancersV1) DeleteMonitor 

func (globalLoadBalancers *GlobalLoadBalancersV1) DeleteMonitor(deleteMonitorOptions *DeleteMonitorOptions) (response *core.DetailedResponse, err error)

DeleteMonitor : Delete a load balancer monitor Delete a load balancer monitor.

func (*GlobalLoadBalancersV1) DeletePool 

func (globalLoadBalancers *GlobalLoadBalancersV1) DeletePool(deletePoolOptions *DeletePoolOptions) (response *core.DetailedResponse, err error)

DeletePool : Delete a load balancer pool Delete a load balancer pool.

func (*GlobalLoadBalancersV1) GetLoadBalancer 

func (globalLoadBalancers *GlobalLoadBalancersV1) GetLoadBalancer(getLoadBalancerOptions *GetLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)

GetLoadBalancer : Get a load balancer Get details of a load balancer.

func (*GlobalLoadBalancersV1) GetMonitor 

func (globalLoadBalancers *GlobalLoadBalancersV1) GetMonitor(getMonitorOptions *GetMonitorOptions) (result *Monitor, response *core.DetailedResponse, err error)

GetMonitor : Get a load balancer monitor Get details of a load balancer monitor.

func (*GlobalLoadBalancersV1) GetPool 

func (globalLoadBalancers *GlobalLoadBalancersV1) GetPool(getPoolOptions *GetPoolOptions) (result *Pool, response *core.DetailedResponse, err error)

GetPool : Get a load balancer pool Get details of a load balancer pool.

func (*GlobalLoadBalancersV1) ListLoadBalancers 

func (globalLoadBalancers *GlobalLoadBalancersV1) ListLoadBalancers(listLoadBalancersOptions *ListLoadBalancersOptions) (result *ListLoadBalancers, response *core.DetailedResponse, err error)

ListLoadBalancers : List load balancers List the Global Load Balancers for a given DNS zone.

func (*GlobalLoadBalancersV1) ListMonitors 

func (globalLoadBalancers *GlobalLoadBalancersV1) ListMonitors(listMonitorsOptions *ListMonitorsOptions) (result *ListMonitors, response *core.DetailedResponse, err error)

ListMonitors : List load balancer monitors List the load balancer monitors.

func (*GlobalLoadBalancersV1) ListPools 

func (globalLoadBalancers *GlobalLoadBalancersV1) ListPools(listPoolsOptions *ListPoolsOptions) (result *ListPools, response *core.DetailedResponse, err error)

ListPools : List load balancer pools List the load balancer pools.

func (*GlobalLoadBalancersV1) NewCreateLoadBalancerOptions 

func (*GlobalLoadBalancersV1) NewCreateLoadBalancerOptions(instanceID string, dnszoneID string) *CreateLoadBalancerOptions

NewCreateLoadBalancerOptions : Instantiate CreateLoadBalancerOptions

func (*GlobalLoadBalancersV1) NewCreateMonitorOptions 

func (*GlobalLoadBalancersV1) NewCreateMonitorOptions(instanceID string) *CreateMonitorOptions

NewCreateMonitorOptions : Instantiate CreateMonitorOptions

func (*GlobalLoadBalancersV1) NewCreatePoolOptions 

func (*GlobalLoadBalancersV1) NewCreatePoolOptions(instanceID string) *CreatePoolOptions

NewCreatePoolOptions : Instantiate CreatePoolOptions

func (*GlobalLoadBalancersV1) NewDeleteLoadBalancerOptions 

func (*GlobalLoadBalancersV1) NewDeleteLoadBalancerOptions(instanceID string, dnszoneID string, lbID string) *DeleteLoadBalancerOptions

NewDeleteLoadBalancerOptions : Instantiate DeleteLoadBalancerOptions

func (*GlobalLoadBalancersV1) NewDeleteMonitorOptions 

func (*GlobalLoadBalancersV1) NewDeleteMonitorOptions(instanceID string, monitorID string) *DeleteMonitorOptions

NewDeleteMonitorOptions : Instantiate DeleteMonitorOptions

func (*GlobalLoadBalancersV1) NewDeletePoolOptions 

func (*GlobalLoadBalancersV1) NewDeletePoolOptions(instanceID string, poolID string) *DeletePoolOptions

NewDeletePoolOptions : Instantiate DeletePoolOptions

func (*GlobalLoadBalancersV1) NewGetLoadBalancerOptions 

func (*GlobalLoadBalancersV1) NewGetLoadBalancerOptions(instanceID string, dnszoneID string, lbID string) *GetLoadBalancerOptions

NewGetLoadBalancerOptions : Instantiate GetLoadBalancerOptions

func (*GlobalLoadBalancersV1) NewGetMonitorOptions 

func (*GlobalLoadBalancersV1) NewGetMonitorOptions(instanceID string, monitorID string) *GetMonitorOptions

NewGetMonitorOptions : Instantiate GetMonitorOptions

func (*GlobalLoadBalancersV1) NewGetPoolOptions 

func (*GlobalLoadBalancersV1) NewGetPoolOptions(instanceID string, poolID string) *GetPoolOptions

NewGetPoolOptions : Instantiate GetPoolOptions

func (*GlobalLoadBalancersV1) NewHealthcheckHeader 

func (*GlobalLoadBalancersV1) NewHealthcheckHeader(name string, value []string) (model *HealthcheckHeader, err error)

NewHealthcheckHeader : Instantiate HealthcheckHeader (Generic Model Constructor)

func (*GlobalLoadBalancersV1) NewListLoadBalancersOptions 

func (*GlobalLoadBalancersV1) NewListLoadBalancersOptions(instanceID string, dnszoneID string) *ListLoadBalancersOptions

NewListLoadBalancersOptions : Instantiate ListLoadBalancersOptions

func (*GlobalLoadBalancersV1) NewListMonitorsOptions 

func (*GlobalLoadBalancersV1) NewListMonitorsOptions(instanceID string) *ListMonitorsOptions

NewListMonitorsOptions : Instantiate ListMonitorsOptions

func (*GlobalLoadBalancersV1) NewListPoolsOptions 

func (*GlobalLoadBalancersV1) NewListPoolsOptions(instanceID string) *ListPoolsOptions

NewListPoolsOptions : Instantiate ListPoolsOptions

func (*GlobalLoadBalancersV1) NewUpdateLoadBalancerOptions 

func (*GlobalLoadBalancersV1) NewUpdateLoadBalancerOptions(instanceID string, dnszoneID string, lbID string) *UpdateLoadBalancerOptions

NewUpdateLoadBalancerOptions : Instantiate UpdateLoadBalancerOptions

func (*GlobalLoadBalancersV1) NewUpdateMonitorOptions 

func (*GlobalLoadBalancersV1) NewUpdateMonitorOptions(instanceID string, monitorID string) *UpdateMonitorOptions

NewUpdateMonitorOptions : Instantiate UpdateMonitorOptions

func (*GlobalLoadBalancersV1) NewUpdatePoolOptions 

func (*GlobalLoadBalancersV1) NewUpdatePoolOptions(instanceID string, poolID string) *UpdatePoolOptions

NewUpdatePoolOptions : Instantiate UpdatePoolOptions

func (*GlobalLoadBalancersV1) SetServiceURL 

func (globalLoadBalancers *GlobalLoadBalancersV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*GlobalLoadBalancersV1) UpdateLoadBalancer 

func (globalLoadBalancers *GlobalLoadBalancersV1) UpdateLoadBalancer(updateLoadBalancerOptions *UpdateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)

UpdateLoadBalancer : Update the properties of a load balancer Update the properties of a load balancer.

func (*GlobalLoadBalancersV1) UpdateMonitor 

func (globalLoadBalancers *GlobalLoadBalancersV1) UpdateMonitor(updateMonitorOptions *UpdateMonitorOptions) (result *Monitor, response *core.DetailedResponse, err error)

UpdateMonitor : Update the properties of a load balancer monitor Update the properties of a load balancer monitor.

func (*GlobalLoadBalancersV1) UpdatePool 

func (globalLoadBalancers *GlobalLoadBalancersV1) UpdatePool(updatePoolOptions *UpdatePoolOptions) (result *Pool, response *core.DetailedResponse, err error)

UpdatePool : Update the properties of a load balancer pool Update the properties of a load balancer pool.

type GlobalLoadBalancersV1Options 

type GlobalLoadBalancersV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

GlobalLoadBalancersV1Options : Service options

type HealthcheckHeader 

type HealthcheckHeader struct {
	// The name of HTTP request header.
	Name *string `json:"name" validate:"required"`

	// The value of HTTP request header.
	Value []string `json:"value" validate:"required"`
}

HealthcheckHeader : The HTTP header of health check request.

type ListLoadBalancers 

type ListLoadBalancers struct {
	// An array of Global Load Balancers.
	LoadBalancers []LoadBalancer `json:"load_balancers" validate:"required"`

	// Page number.
	Offset *int64 `json:"offset" validate:"required"`

	// Number of Global Load Balancers per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Number of Global Load Balancers.
	Count *int64 `json:"count" validate:"required"`

	// Total number of Global Load Balancers.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// href.
	First *FirstHref `json:"first" validate:"required"`

	// href.
	Next *NextHref `json:"next" validate:"required"`
}

ListLoadBalancers : List Global Load Balancers response.

type ListLoadBalancersOptions 

type ListLoadBalancersOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a DNS zone.
	DnszoneID *string `json:"dnszone_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

ListLoadBalancersOptions : The ListLoadBalancers options.

func (*ListLoadBalancersOptions) SetDnszoneID 

func (options *ListLoadBalancersOptions) SetDnszoneID(dnszoneID string) *ListLoadBalancersOptions

SetDnszoneID : Allow user to set DnszoneID

func (*ListLoadBalancersOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListLoadBalancersOptions) SetInstanceID 

func (options *ListLoadBalancersOptions) SetInstanceID(instanceID string) *ListLoadBalancersOptions

SetInstanceID : Allow user to set InstanceID

func (*ListLoadBalancersOptions) SetXCorrelationID 

func (options *ListLoadBalancersOptions) SetXCorrelationID(xCorrelationID string) *ListLoadBalancersOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ListMonitors 

type ListMonitors struct {
	// An array of load balancer monitors.
	Monitors []Monitor `json:"monitors" validate:"required"`

	// Page number.
	Offset *int64 `json:"offset" validate:"required"`

	// Number of load balancer monitors per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Number of load balancers.
	Count *int64 `json:"count" validate:"required"`

	// Total number of load balancers.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// href.
	First *FirstHref `json:"first" validate:"required"`

	// href.
	Next *NextHref `json:"next" validate:"required"`
}

ListMonitors : List load balancer monitors response.

type ListMonitorsOptions 

type ListMonitorsOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

ListMonitorsOptions : The ListMonitors options.

func (*ListMonitorsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListMonitorsOptions) SetInstanceID 

func (options *ListMonitorsOptions) SetInstanceID(instanceID string) *ListMonitorsOptions

SetInstanceID : Allow user to set InstanceID

func (*ListMonitorsOptions) SetXCorrelationID 

func (options *ListMonitorsOptions) SetXCorrelationID(xCorrelationID string) *ListMonitorsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ListPools 

type ListPools struct {
	// An array of load balancer pools.
	Pools []Pool `json:"pools" validate:"required"`

	// Page number.
	Offset *int64 `json:"offset" validate:"required"`

	// Number of load balancer pools per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Number of load balancers.
	Count *int64 `json:"count" validate:"required"`

	// Total number of load balancers.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// href.
	First *FirstHref `json:"first" validate:"required"`

	// href.
	Next *NextHref `json:"next" validate:"required"`
}

ListPools : List load balancer pools response.

type ListPoolsOptions 

type ListPoolsOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

ListPoolsOptions : The ListPools options.

func (*ListPoolsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListPoolsOptions) SetInstanceID 

func (options *ListPoolsOptions) SetInstanceID(instanceID string) *ListPoolsOptions

SetInstanceID : Allow user to set InstanceID

func (*ListPoolsOptions) SetXCorrelationID 

func (options *ListPoolsOptions) SetXCorrelationID(xCorrelationID string) *ListPoolsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type LoadBalancer 

type LoadBalancer struct {
	// Identifier of the load balancer.
	ID *string `json:"id,omitempty"`

	// Name of the load balancer.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer.
	Description *string `json:"description,omitempty"`

	// Whether the load balancer is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Time to live in second.
	TTL *int64 `json:"ttl,omitempty"`

	// Healthy state of the load balancer.
	Health *string `json:"health,omitempty"`

	// The pool ID to use when all other pools are detected as unhealthy.
	FallbackPool *string `json:"fallback_pool,omitempty"`

	// A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools
	// are not configured for a given region.
	DefaultPools []string `json:"default_pools,omitempty"`

	// Map availability zones to pool ID's.
	AzPools []LoadBalancerAzPoolsItem `json:"az_pools,omitempty"`

	// the time when a load balancer is created.
	CreatedOn *string `json:"created_on,omitempty"`

	// the recent time when a load balancer is modified.
	ModifiedOn *string `json:"modified_on,omitempty"`
}

LoadBalancer : Load balancer details.

type LoadBalancerAzPoolsItem 

type LoadBalancerAzPoolsItem struct {
	// Availability zone.
	AvailabilityZone *string `json:"availability_zone,omitempty"`

	// List of load balancer pools.
	Pools []string `json:"pools,omitempty"`
}

LoadBalancerAzPoolsItem : LoadBalancerAzPoolsItem struct

type Monitor 

type Monitor struct {
	// Identifier of the load balancer monitor.
	ID *string `json:"id,omitempty"`

	// The name of the load balancer monitor.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer monitor.
	Description *string `json:"description,omitempty"`

	// The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
	Type *string `json:"type,omitempty"`

	// Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define
	// the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
	Port *int64 `json:"port,omitempty"`

	// The interval between each health check. Shorter intervals may improve failover time, but will increase load on the
	// origins as we check from multiple locations.
	Interval *int64 `json:"interval,omitempty"`

	// The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted
	// immediately.
	Retries *int64 `json:"retries,omitempty"`

	// The timeout (in seconds) before marking the health check as failed.
	Timeout *int64 `json:"timeout,omitempty"`

	// The method to use for the health check applicable to HTTP/HTTPS based checks, the default value is 'GET'.
	Method *string `json:"method,omitempty"`

	// The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
	Path *string `json:"path,omitempty"`

	// The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The
	// User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
	HeadersVar []HealthcheckHeader `json:"headers,omitempty"`

	// Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
	AllowInsecure *bool `json:"allow_insecure,omitempty"`

	// The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS
	// monitors.
	ExpectedCodes *string `json:"expected_codes,omitempty"`

	// A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be
	// marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
	ExpectedBody *string `json:"expected_body,omitempty"`

	// the time when a load balancer monitor is created.
	CreatedOn *string `json:"created_on,omitempty"`

	// the recent time when a load balancer monitor is modified.
	ModifiedOn *string `json:"modified_on,omitempty"`
}

Monitor : Load balancer monitor details.

type NextHref 

type NextHref struct {
	// href.
	Href *string `json:"href,omitempty"`
}

NextHref : href.

type Origin 

type Origin struct {
	// The name of the origin server.
	Name *string `json:"name,omitempty"`

	// Description of the origin server.
	Description *string `json:"description,omitempty"`

	// The address of the origin server. It can be a hostname or an IP address.
	Address *string `json:"address,omitempty"`

	// Whether the origin server is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// The health state of the origin server.
	Health *bool `json:"health,omitempty"`

	// The failure reason of the origin server if it is unhealthy.
	HealthFailureReason *string `json:"health_failure_reason,omitempty"`
}

Origin : Origin server.

type OriginInput 

type OriginInput struct {
	// The name of the origin server.
	Name *string `json:"name,omitempty"`

	// Description of the origin server.
	Description *string `json:"description,omitempty"`

	// The address of the origin server. It can be a hostname or an IP address.
	Address *string `json:"address,omitempty"`

	// Whether the origin server is enabled.
	Enabled *bool `json:"enabled,omitempty"`
}

OriginInput : The request data of origin server.

type Pool 

type Pool struct {
	// Identifier of the load balancer pool.
	ID *string `json:"id,omitempty"`

	// Name of the load balancer pool.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer pool.
	Description *string `json:"description,omitempty"`

	// Whether the load balancer pool is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins
	// falls below this number, the pool will be marked unhealthy and we will failover to the next available pool.
	HealthyOriginsThreshold *int64 `json:"healthy_origins_threshold,omitempty"`

	// The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy
	// origins, provided the pool itself is healthy.
	Origins []Origin `json:"origins,omitempty"`

	// The ID of the load balancer monitor to be associated to this pool.
	Monitor *string `json:"monitor,omitempty"`

	// The notification channel.
	NotificationChannel *string `json:"notification_channel,omitempty"`

	// Healthy state of the load balancer pool.
	Health *string `json:"health,omitempty"`

	// Health check region of VSIs.
	HealthcheckRegion *string `json:"healthcheck_region,omitempty"`

	// Health check subnet IDs of VSIs.
	HealthcheckSubnets []string `json:"healthcheck_subnets,omitempty"`

	// the time when a load balancer pool is created.
	CreatedOn *string `json:"created_on,omitempty"`

	// the recent time when a load balancer pool is modified.
	ModifiedOn *string `json:"modified_on,omitempty"`
}

Pool : Load balancer pool details.

type UpdateLoadBalancerOptions 

type UpdateLoadBalancerOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a DNS zone.
	DnszoneID *string `json:"dnszone_id" validate:"required"`

	// The unique identifier of a load balancer.
	LbID *string `json:"lb_id" validate:"required"`

	// Name of the load balancer.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer.
	Description *string `json:"description,omitempty"`

	// Whether the load balancer is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Time to live in second.
	TTL *int64 `json:"ttl,omitempty"`

	// The pool ID to use when all other pools are detected as unhealthy.
	FallbackPool *string `json:"fallback_pool,omitempty"`

	// A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools
	// are not configured for a given region.
	DefaultPools []string `json:"default_pools,omitempty"`

	// Map availability zones to pool ID's.
	AzPools []LoadBalancerAzPoolsItem `json:"az_pools,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

UpdateLoadBalancerOptions : The UpdateLoadBalancer options.

func (*UpdateLoadBalancerOptions) SetAzPools 

func (options *UpdateLoadBalancerOptions) SetAzPools(azPools []LoadBalancerAzPoolsItem) *UpdateLoadBalancerOptions

SetAzPools : Allow user to set AzPools

func (*UpdateLoadBalancerOptions) SetDefaultPools 

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

SetDefaultPools : Allow user to set DefaultPools

func (*UpdateLoadBalancerOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*UpdateLoadBalancerOptions) SetDnszoneID 

func (options *UpdateLoadBalancerOptions) SetDnszoneID(dnszoneID string) *UpdateLoadBalancerOptions

SetDnszoneID : Allow user to set DnszoneID

func (*UpdateLoadBalancerOptions) SetEnabled 

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

SetEnabled : Allow user to set Enabled

func (*UpdateLoadBalancerOptions) SetFallbackPool 

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

SetFallbackPool : Allow user to set FallbackPool

func (*UpdateLoadBalancerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateLoadBalancerOptions) SetInstanceID 

func (options *UpdateLoadBalancerOptions) SetInstanceID(instanceID string) *UpdateLoadBalancerOptions

SetInstanceID : Allow user to set InstanceID

func (*UpdateLoadBalancerOptions) SetLbID 

func (options *UpdateLoadBalancerOptions) SetLbID(lbID string) *UpdateLoadBalancerOptions

SetLbID : Allow user to set LbID

func (*UpdateLoadBalancerOptions) SetName 

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

SetName : Allow user to set Name

func (*UpdateLoadBalancerOptions) SetTTL 

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

SetTTL : Allow user to set TTL

func (*UpdateLoadBalancerOptions) SetXCorrelationID 

func (options *UpdateLoadBalancerOptions) SetXCorrelationID(xCorrelationID string) *UpdateLoadBalancerOptions

SetXCorrelationID : Allow user to set XCorrelationID

type UpdateMonitorOptions 

type UpdateMonitorOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a load balancer monitor.
	MonitorID *string `json:"monitor_id" validate:"required"`

	// The name of the load balancer monitor.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer monitor.
	Description *string `json:"description,omitempty"`

	// The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
	Type *string `json:"type,omitempty"`

	// Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define
	// the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
	Port *int64 `json:"port,omitempty"`

	// The interval between each health check. Shorter intervals may improve failover time, but will increase load on the
	// origins as we check from multiple locations.
	Interval *int64 `json:"interval,omitempty"`

	// The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted
	// immediately.
	Retries *int64 `json:"retries,omitempty"`

	// The timeout (in seconds) before marking the health check as failed.
	Timeout *int64 `json:"timeout,omitempty"`

	// The method to use for the health check applicable to HTTP/HTTPS based checks, the default value is 'GET'.
	Method *string `json:"method,omitempty"`

	// The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
	Path *string `json:"path,omitempty"`

	// The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The
	// User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
	HeadersVar []HealthcheckHeader `json:"headers,omitempty"`

	// Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS
	// monitors.
	AllowInsecure *bool `json:"allow_insecure,omitempty"`

	// The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS
	// monitors.
	ExpectedCodes *string `json:"expected_codes,omitempty"`

	// A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be
	// marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
	ExpectedBody *string `json:"expected_body,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

UpdateMonitorOptions : The UpdateMonitor options.

func (*UpdateMonitorOptions) SetAllowInsecure 

func (options *UpdateMonitorOptions) SetAllowInsecure(allowInsecure bool) *UpdateMonitorOptions

SetAllowInsecure : Allow user to set AllowInsecure

func (*UpdateMonitorOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*UpdateMonitorOptions) SetExpectedBody 

func (options *UpdateMonitorOptions) SetExpectedBody(expectedBody string) *UpdateMonitorOptions

SetExpectedBody : Allow user to set ExpectedBody

func (*UpdateMonitorOptions) SetExpectedCodes 

func (options *UpdateMonitorOptions) SetExpectedCodes(expectedCodes string) *UpdateMonitorOptions

SetExpectedCodes : Allow user to set ExpectedCodes

func (*UpdateMonitorOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateMonitorOptions) SetHeadersVar 

func (options *UpdateMonitorOptions) SetHeadersVar(headersVar []HealthcheckHeader) *UpdateMonitorOptions

SetHeadersVar : Allow user to set HeadersVar

func (*UpdateMonitorOptions) SetInstanceID 

func (options *UpdateMonitorOptions) SetInstanceID(instanceID string) *UpdateMonitorOptions

SetInstanceID : Allow user to set InstanceID

func (*UpdateMonitorOptions) SetInterval 

func (options *UpdateMonitorOptions) SetInterval(interval int64) *UpdateMonitorOptions

SetInterval : Allow user to set Interval

func (*UpdateMonitorOptions) SetMethod 

func (options *UpdateMonitorOptions) SetMethod(method string) *UpdateMonitorOptions

SetMethod : Allow user to set Method

func (*UpdateMonitorOptions) SetMonitorID 

func (options *UpdateMonitorOptions) SetMonitorID(monitorID string) *UpdateMonitorOptions

SetMonitorID : Allow user to set MonitorID

func (*UpdateMonitorOptions) SetName 

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

SetName : Allow user to set Name

func (*UpdateMonitorOptions) SetPath 

func (options *UpdateMonitorOptions) SetPath(path string) *UpdateMonitorOptions

SetPath : Allow user to set Path

func (*UpdateMonitorOptions) SetPort 

func (options *UpdateMonitorOptions) SetPort(port int64) *UpdateMonitorOptions

SetPort : Allow user to set Port

func (*UpdateMonitorOptions) SetRetries 

func (options *UpdateMonitorOptions) SetRetries(retries int64) *UpdateMonitorOptions

SetRetries : Allow user to set Retries

func (*UpdateMonitorOptions) SetTimeout 

func (options *UpdateMonitorOptions) SetTimeout(timeout int64) *UpdateMonitorOptions

SetTimeout : Allow user to set Timeout

func (*UpdateMonitorOptions) SetType 

func (options *UpdateMonitorOptions) SetType(typeVar string) *UpdateMonitorOptions

SetType : Allow user to set Type

func (*UpdateMonitorOptions) SetXCorrelationID 

func (options *UpdateMonitorOptions) SetXCorrelationID(xCorrelationID string) *UpdateMonitorOptions

SetXCorrelationID : Allow user to set XCorrelationID

type UpdatePoolOptions 

type UpdatePoolOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a load balancer pool.
	PoolID *string `json:"pool_id" validate:"required"`

	// Name of the load balancer pool.
	Name *string `json:"name,omitempty"`

	// Descriptive text of the load balancer pool.
	Description *string `json:"description,omitempty"`

	// Whether the load balancer pool is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins
	// falls below this number, the pool will be marked unhealthy and we will failover to the next available pool.
	HealthyOriginsThreshold *int64 `json:"healthy_origins_threshold,omitempty"`

	// The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy
	// origins, provided the pool itself is healthy.
	Origins []OriginInput `json:"origins,omitempty"`

	// The ID of the load balancer monitor to be associated to this pool.
	Monitor *string `json:"monitor,omitempty"`

	// The notification channel.
	NotificationChannel *string `json:"notification_channel,omitempty"`

	// Health check region of VSIs.
	HealthcheckRegion *string `json:"healthcheck_region,omitempty"`

	// Health check subnet IDs of VSIs.
	HealthcheckSubnets []string `json:"healthcheck_subnets,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

UpdatePoolOptions : The UpdatePool options.

func (*UpdatePoolOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*UpdatePoolOptions) SetEnabled 

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

SetEnabled : Allow user to set Enabled

func (*UpdatePoolOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdatePoolOptions) SetHealthcheckRegion 

func (options *UpdatePoolOptions) SetHealthcheckRegion(healthcheckRegion string) *UpdatePoolOptions

SetHealthcheckRegion : Allow user to set HealthcheckRegion

func (*UpdatePoolOptions) SetHealthcheckSubnets 

func (options *UpdatePoolOptions) SetHealthcheckSubnets(healthcheckSubnets []string) *UpdatePoolOptions

SetHealthcheckSubnets : Allow user to set HealthcheckSubnets

func (*UpdatePoolOptions) SetHealthyOriginsThreshold 

func (options *UpdatePoolOptions) SetHealthyOriginsThreshold(healthyOriginsThreshold int64) *UpdatePoolOptions

SetHealthyOriginsThreshold : Allow user to set HealthyOriginsThreshold

func (*UpdatePoolOptions) SetInstanceID 

func (options *UpdatePoolOptions) SetInstanceID(instanceID string) *UpdatePoolOptions

SetInstanceID : Allow user to set InstanceID

func (*UpdatePoolOptions) SetMonitor 

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

SetMonitor : Allow user to set Monitor

func (*UpdatePoolOptions) SetName 

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

SetName : Allow user to set Name

func (*UpdatePoolOptions) SetNotificationChannel 

func (options *UpdatePoolOptions) SetNotificationChannel(notificationChannel string) *UpdatePoolOptions

SetNotificationChannel : Allow user to set NotificationChannel

func (*UpdatePoolOptions) SetOrigins 

func (options *UpdatePoolOptions) SetOrigins(origins []OriginInput) *UpdatePoolOptions

SetOrigins : Allow user to set Origins

func (*UpdatePoolOptions) SetPoolID 

func (options *UpdatePoolOptions) SetPoolID(poolID string) *UpdatePoolOptions

SetPoolID : Allow user to set PoolID

func (*UpdatePoolOptions) SetXCorrelationID 

func (options *UpdatePoolOptions) SetXCorrelationID(xCorrelationID string) *UpdatePoolOptions

SetXCorrelationID : Allow user to set XCorrelationID

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.