routingv1

package
v0.32.0 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2022 License: Apache-2.0 Imports: 9 Imported by: 4

Documentation

Overview

Package routingv1 : Operations and models for the RoutingV1 service

Index

Constants

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

Constants associated with the UpdateSmartRoutingOptions.Value property. Value.

View Source 
const DefaultServiceName = "routing"

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 GetServiceURLForRegion added in v0.12.1 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

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) Clone added in v0.12.1 

func (routing *RoutingV1) Clone() *RoutingV1

Clone makes a copy of "routing" suitable for processing requests.

func (*RoutingV1) DisableRetries added in v0.12.1 

func (routing *RoutingV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*RoutingV1) EnableRetries added in v0.12.1 

func (routing *RoutingV1) 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 (*RoutingV1) GetEnableGzipCompression added in v0.12.1 

func (routing *RoutingV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*RoutingV1) GetServiceURL added in v0.12.1 

func (routing *RoutingV1) GetServiceURL() string

GetServiceURL returns the service URL

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) GetSmartRoutingWithContext added in v0.12.1 

func (routing *RoutingV1) GetSmartRoutingWithContext(ctx context.Context, getSmartRoutingOptions *GetSmartRoutingOptions) (result *SmartRoutingResp, response *core.DetailedResponse, err error)

GetSmartRoutingWithContext is an alternate form of the GetSmartRouting method which supports a Context parameter

func (*RoutingV1) NewGetSmartRoutingOptions 

func (*RoutingV1) NewGetSmartRoutingOptions() *GetSmartRoutingOptions

NewGetSmartRoutingOptions : Instantiate GetSmartRoutingOptions

func (*RoutingV1) NewUpdateSmartRoutingOptions 

func (*RoutingV1) NewUpdateSmartRoutingOptions() *UpdateSmartRoutingOptions

NewUpdateSmartRoutingOptions : Instantiate UpdateSmartRoutingOptions

func (*RoutingV1) SetDefaultHeaders added in v0.12.1 

func (routing *RoutingV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*RoutingV1) SetEnableGzipCompression added in v0.12.1 

func (routing *RoutingV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

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.

func (*RoutingV1) UpdateSmartRoutingWithContext added in v0.12.1 

func (routing *RoutingV1) UpdateSmartRoutingWithContext(ctx context.Context, updateSmartRoutingOptions *UpdateSmartRoutingOptions) (result *SmartRoutingResp, response *core.DetailedResponse, err error)

UpdateSmartRoutingWithContext is an alternate form of the UpdateSmartRouting method which supports a Context parameter

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

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.