botmanagementv1

package
v0.49.0 Latest Latest
Warning

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

 Go to latest Published: Jul 12, 2024 License: Apache-2.0 Imports: 8 Imported by: 1

Documentation

Overview

Package botmanagementv1 : Operations and models for the BotManagementV1 service

Index

Constants

View Source 
const DefaultServiceName = "bot_management"

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 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalBotMgtResp 

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

UnmarshalBotMgtResp unmarshals an instance of BotMgtResp from the specified map of raw messages.

func UnmarshalBotMgtRespResult 

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

UnmarshalBotMgtRespResult unmarshals an instance of BotMgtRespResult from the specified map of raw messages.

Types

type BotManagementV1 

type BotManagementV1 struct {
	Service *core.BaseService

	// Full url-encoded CRN of the service instance.
	Crn *string

	// Identifier of zone.
	ZoneIdentifier *string
}

BotManagementV1 : Bot Management

API Version: 1.0.1

func NewBotManagementV1 

func NewBotManagementV1(options *BotManagementV1Options) (service *BotManagementV1, err error)

NewBotManagementV1 : constructs an instance of BotManagementV1 with passed in options.

func NewBotManagementV1UsingExternalConfig 

func NewBotManagementV1UsingExternalConfig(options *BotManagementV1Options) (botManagement *BotManagementV1, err error)

NewBotManagementV1UsingExternalConfig : constructs an instance of BotManagementV1 with passed in options and external configuration.

func (*BotManagementV1) Clone 

func (botManagement *BotManagementV1) Clone() *BotManagementV1

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

func (*BotManagementV1) DisableRetries 

func (botManagement *BotManagementV1) DisableRetries()

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

func (*BotManagementV1) EnableRetries 

func (botManagement *BotManagementV1) 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 (*BotManagementV1) GetBotManagement 

func (botManagement *BotManagementV1) GetBotManagement(getBotManagementOptions *GetBotManagementOptions) (result *BotMgtResp, response *core.DetailedResponse, err error)

GetBotManagement : Get Bot management setting Get Bot management setting for a given zone.

func (*BotManagementV1) GetBotManagementWithContext 

func (botManagement *BotManagementV1) GetBotManagementWithContext(ctx context.Context, getBotManagementOptions *GetBotManagementOptions) (result *BotMgtResp, response *core.DetailedResponse, err error)

GetBotManagementWithContext is an alternate form of the GetBotManagement method which supports a Context parameter

func (*BotManagementV1) GetEnableGzipCompression 

func (botManagement *BotManagementV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*BotManagementV1) GetServiceURL 

func (botManagement *BotManagementV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*BotManagementV1) NewGetBotManagementOptions 

func (*BotManagementV1) NewGetBotManagementOptions() *GetBotManagementOptions

NewGetBotManagementOptions : Instantiate GetBotManagementOptions

func (*BotManagementV1) NewUpdateBotManagementOptions 

func (*BotManagementV1) NewUpdateBotManagementOptions() *UpdateBotManagementOptions

NewUpdateBotManagementOptions : Instantiate UpdateBotManagementOptions

func (*BotManagementV1) SetDefaultHeaders 

func (botManagement *BotManagementV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*BotManagementV1) SetEnableGzipCompression 

func (botManagement *BotManagementV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*BotManagementV1) SetServiceURL 

func (botManagement *BotManagementV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*BotManagementV1) UpdateBotManagement 

func (botManagement *BotManagementV1) UpdateBotManagement(updateBotManagementOptions *UpdateBotManagementOptions) (result *BotMgtResp, response *core.DetailedResponse, err error)

UpdateBotManagement : Update Bot management setting Update Bot management setting for given zone.

func (*BotManagementV1) UpdateBotManagementWithContext 

func (botManagement *BotManagementV1) UpdateBotManagementWithContext(ctx context.Context, updateBotManagementOptions *UpdateBotManagementOptions) (result *BotMgtResp, response *core.DetailedResponse, err error)

UpdateBotManagementWithContext is an alternate form of the UpdateBotManagement method which supports a Context parameter

type BotManagementV1Options 

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

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

	// Identifier of zone.
	ZoneIdentifier *string `validate:"required"`
}

BotManagementV1Options : Service options

type BotMgtResp 

type BotMgtResp struct {
	// Was operation 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"`

	// Container for response information.
	Result *BotMgtRespResult `json:"result" validate:"required"`
}

BotMgtResp : Bot Management Response.

type BotMgtRespResult 

type BotMgtRespResult struct {
	FightMode *bool `json:"fight_mode,omitempty"`

	SessionScore *bool `json:"session_score,omitempty"`

	EnableJs *bool `json:"enable_js,omitempty"`

	AuthIdLogging *bool `json:"auth_id_logging,omitempty"`

	UseLatestModel *bool `json:"use_latest_model,omitempty"`
}

BotMgtRespResult : Container for response information.

type GetBotManagementOptions 

type GetBotManagementOptions struct {

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

GetBotManagementOptions : The GetBotManagement options.

func (*GetBotManagementOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

type UpdateBotManagementOptions 

type UpdateBotManagementOptions struct {
	FightMode *bool `json:"fight_mode,omitempty"`

	SessionScore *bool `json:"session_score,omitempty"`

	EnableJs *bool `json:"enable_js,omitempty"`

	AuthIdLogging *bool `json:"auth_id_logging,omitempty"`

	UseLatestModel *bool `json:"use_latest_model,omitempty"`

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

UpdateBotManagementOptions : The UpdateBotManagement options.

func (*UpdateBotManagementOptions) SetAuthIdLogging 

func (_options *UpdateBotManagementOptions) SetAuthIdLogging(authIdLogging bool) *UpdateBotManagementOptions

SetAuthIdLogging : Allow user to set AuthIdLogging

func (*UpdateBotManagementOptions) SetEnableJs 

func (_options *UpdateBotManagementOptions) SetEnableJs(enableJs bool) *UpdateBotManagementOptions

SetEnableJs : Allow user to set EnableJs

func (*UpdateBotManagementOptions) SetFightMode 

func (_options *UpdateBotManagementOptions) SetFightMode(fightMode bool) *UpdateBotManagementOptions

SetFightMode : Allow user to set FightMode

func (*UpdateBotManagementOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateBotManagementOptions) SetSessionScore 

func (_options *UpdateBotManagementOptions) SetSessionScore(sessionScore bool) *UpdateBotManagementOptions

SetSessionScore : Allow user to set SessionScore

func (*UpdateBotManagementOptions) SetUseLatestModel 

func (_options *UpdateBotManagementOptions) SetUseLatestModel(useLatestModel bool) *UpdateBotManagementOptions

SetUseLatestModel : Allow user to set UseLatestModel

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.