routingv1

Documentation

Overview

Package routingv1 : Operations and models for the RoutingV1 service

Index

• Constants
• func UnmarshalSmartRoutingResp(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalSmartRoutingRespResult(m map[string]json.RawMessage, result interface{}) (err error)
• type GetSmartRoutingOptions
  • func (options *GetSmartRoutingOptions) SetHeaders(param map[string]string) *GetSmartRoutingOptions
• type RoutingV1
  • func NewRoutingV1(options *RoutingV1Options) (service *RoutingV1, err error)
  • func NewRoutingV1UsingExternalConfig(options *RoutingV1Options) (routing *RoutingV1, err error)
  • func (routing *RoutingV1) GetSmartRouting(getSmartRoutingOptions *GetSmartRoutingOptions) (result *SmartRoutingResp, response *core.DetailedResponse, err error)
  • func (*RoutingV1) NewGetSmartRoutingOptions() *GetSmartRoutingOptions
  • func (*RoutingV1) NewUpdateSmartRoutingOptions() *UpdateSmartRoutingOptions
  • func (routing *RoutingV1) SetServiceURL(url string) error
  • func (routing *RoutingV1) UpdateSmartRouting(updateSmartRoutingOptions *UpdateSmartRoutingOptions) (result *SmartRoutingResp, response *core.DetailedResponse, err error)
• type RoutingV1Options
• type SmartRoutingResp
• type SmartRoutingRespResult
• type UpdateSmartRoutingOptions
  • func (options *UpdateSmartRoutingOptions) SetHeaders(param map[string]string) *UpdateSmartRoutingOptions
  • func (options *UpdateSmartRoutingOptions) SetValue(value string) *UpdateSmartRoutingOptions

Constants

const (
	UpdateSmartRoutingOptions_Value_Off = "off"
	UpdateSmartRoutingOptions_Value_On  = "on"
)

Constants associated with the UpdateSmartRoutingOptions.Value property. Value.

const DefaultServiceName = "routing"

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.

Functions

func UnmarshalSmartRoutingResp

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

UnmarshalSmartRoutingResp unmarshals an instance of SmartRoutingResp from the specified map of raw messages.

func UnmarshalSmartRoutingRespResult

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

UnmarshalSmartRoutingRespResult unmarshals an instance of SmartRoutingRespResult from the specified map of raw messages.

Types

type GetSmartRoutingOptions

type GetSmartRoutingOptions struct {

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

GetSmartRoutingOptions : The GetSmartRouting options.

func (*GetSmartRoutingOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type RoutingV1

type RoutingV1 struct {
	Service *core.BaseService

	// Full url-encoded cloud resource name (CRN) of resource instance.
	Crn *string

	// Zone identifier.
	ZoneIdentifier *string
}

RoutingV1 : Routing

Version: 1.0.1

func NewRoutingV1

func NewRoutingV1(options *RoutingV1Options) (service *RoutingV1, err error)

NewRoutingV1 : constructs an instance of RoutingV1 with passed in options.

func NewRoutingV1UsingExternalConfig

func NewRoutingV1UsingExternalConfig(options *RoutingV1Options) (routing *RoutingV1, err error)

NewRoutingV1UsingExternalConfig : constructs an instance of RoutingV1 with passed in options and external configuration.

func (*RoutingV1) GetSmartRouting

func (routing *RoutingV1) GetSmartRouting(getSmartRoutingOptions *GetSmartRoutingOptions) (result *SmartRoutingResp, response *core.DetailedResponse, err error)

GetSmartRouting : Get Routing feature smart routing setting Get Routing feature smart routing setting for a zone.

func (*RoutingV1) NewGetSmartRoutingOptions

func (*RoutingV1) NewGetSmartRoutingOptions() *GetSmartRoutingOptions

NewGetSmartRoutingOptions : Instantiate GetSmartRoutingOptions

func (*RoutingV1) NewUpdateSmartRoutingOptions

func (*RoutingV1) NewUpdateSmartRoutingOptions() *UpdateSmartRoutingOptions

NewUpdateSmartRoutingOptions : Instantiate UpdateSmartRoutingOptions

func (*RoutingV1) SetServiceURL

func (routing *RoutingV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*RoutingV1) UpdateSmartRouting

func (routing *RoutingV1) UpdateSmartRouting(updateSmartRoutingOptions *UpdateSmartRoutingOptions) (result *SmartRoutingResp, response *core.DetailedResponse, err error)

UpdateSmartRouting : Update Routing feature smart route setting Update Routing feature smart route setting for a zone.

type RoutingV1Options

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

	// Full url-encoded cloud resource name (CRN) of resource instance.
	Crn *string `validate:"required"`

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

RoutingV1Options : Service options

type SmartRoutingResp

type SmartRoutingResp struct {
	// Container for response information.
	Result *SmartRoutingRespResult `json:"result" validate:"required"`

	// Was the get successful.
	Success *bool `json:"success" validate:"required"`

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

	// Array of messages returned.
	Messages [][]string `json:"messages" validate:"required"`
}

SmartRoutingResp : smart routing response.

type SmartRoutingRespResult

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

	// Value.
	Value *string `json:"value" validate:"required"`

	// Editable.
	Editable *bool `json:"editable" validate:"required"`

	// Modified date.
	ModifiedOn *strfmt.DateTime `json:"modified_on" validate:"required"`
}

SmartRoutingRespResult : Container for response information.

type UpdateSmartRoutingOptions

type UpdateSmartRoutingOptions struct {
	// Value.
	Value *string `json:"value,omitempty"`

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

UpdateSmartRoutingOptions : The UpdateSmartRouting options.

func (*UpdateSmartRoutingOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateSmartRoutingOptions) SetValue

func (options *UpdateSmartRoutingOptions) SetValue(value string) *UpdateSmartRoutingOptions

SetValue : Allow user to set Value