botanalyticsv1

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: 10 Imported by: 1

Documentation

Overview

Package botanalyticsv1 : Operations and models for the BotAnalyticsV1 service

Index

Constants

View Source 
const DefaultServiceName = "bot_analytics"

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 UnmarshalBotScoreResp 

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

UnmarshalBotScoreResp unmarshals an instance of BotScoreResp from the specified map of raw messages.

func UnmarshalBotScoreRespResultItem 

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

UnmarshalBotScoreRespResultItem unmarshals an instance of BotScoreRespResultItem from the specified map of raw messages.

func UnmarshalBotScoreRespResultItemBotScoreItem 

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

UnmarshalBotScoreRespResultItemBotScoreItem unmarshals an instance of BotScoreRespResultItemBotScoreItem from the specified map of raw messages.

func UnmarshalBotScoreRespResultItemBotScoreItemAvg 

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

UnmarshalBotScoreRespResultItemBotScoreItemAvg unmarshals an instance of BotScoreRespResultItemBotScoreItemAvg from the specified map of raw messages.

func UnmarshalBotScoreRespResultItemBotScoreItemDimensions 

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

UnmarshalBotScoreRespResultItemBotScoreItemDimensions unmarshals an instance of BotScoreRespResultItemBotScoreItemDimensions from the specified map of raw messages.

func UnmarshalBotTimeseriesResp 

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

UnmarshalBotTimeseriesResp unmarshals an instance of BotTimeseriesResp from the specified map of raw messages.

func UnmarshalBotTimeseriesRespResultItem 

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

UnmarshalBotTimeseriesRespResultItem unmarshals an instance of BotTimeseriesRespResultItem from the specified map of raw messages.

func UnmarshalBotTopnsResp 

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

UnmarshalBotTopnsResp unmarshals an instance of BotTopnsResp from the specified map of raw messages.

Types

type BotAnalyticsV1 

type BotAnalyticsV1 struct {
	Service *core.BaseService

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

	// Zone identifier to identifiy the zone.
	ZoneIdentifier *string
}

BotAnalyticsV1 : Bot Analytics

API Version: 1.0.1

func NewBotAnalyticsV1 

func NewBotAnalyticsV1(options *BotAnalyticsV1Options) (service *BotAnalyticsV1, err error)

NewBotAnalyticsV1 : constructs an instance of BotAnalyticsV1 with passed in options.

func NewBotAnalyticsV1UsingExternalConfig 

func NewBotAnalyticsV1UsingExternalConfig(options *BotAnalyticsV1Options) (botAnalytics *BotAnalyticsV1, err error)

NewBotAnalyticsV1UsingExternalConfig : constructs an instance of BotAnalyticsV1 with passed in options and external configuration.

func (*BotAnalyticsV1) Clone 

func (botAnalytics *BotAnalyticsV1) Clone() *BotAnalyticsV1

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

func (*BotAnalyticsV1) DisableRetries 

func (botAnalytics *BotAnalyticsV1) DisableRetries()

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

func (*BotAnalyticsV1) EnableRetries 

func (botAnalytics *BotAnalyticsV1) 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 (*BotAnalyticsV1) GetBotScore 

func (botAnalytics *BotAnalyticsV1) GetBotScore(getBotScoreOptions *GetBotScoreOptions) (result *BotScoreResp, response *core.DetailedResponse, err error)

GetBotScore : Get Bot Analytics score source Get Bot Analytics score source for a given zone. Use this to identify the most common detection engines used to score your traffic.

func (*BotAnalyticsV1) GetBotScoreWithContext 

func (botAnalytics *BotAnalyticsV1) GetBotScoreWithContext(ctx context.Context, getBotScoreOptions *GetBotScoreOptions) (result *BotScoreResp, response *core.DetailedResponse, err error)

GetBotScoreWithContext is an alternate form of the GetBotScore method which supports a Context parameter

func (*BotAnalyticsV1) GetBotTimeseries 

func (botAnalytics *BotAnalyticsV1) GetBotTimeseries(getBotTimeseriesOptions *GetBotTimeseriesOptions) (result *BotTimeseriesResp, response *core.DetailedResponse, err error)

GetBotTimeseries : Get Bot Analytics timeseries Get Bot Analytics timeseries for a given zone.

func (*BotAnalyticsV1) GetBotTimeseriesWithContext 

func (botAnalytics *BotAnalyticsV1) GetBotTimeseriesWithContext(ctx context.Context, getBotTimeseriesOptions *GetBotTimeseriesOptions) (result *BotTimeseriesResp, response *core.DetailedResponse, err error)

GetBotTimeseriesWithContext is an alternate form of the GetBotTimeseries method which supports a Context parameter

func (*BotAnalyticsV1) GetBotTopns 

func (botAnalytics *BotAnalyticsV1) GetBotTopns(getBotTopnsOptions *GetBotTopnsOptions) (result *BotTopnsResp, response *core.DetailedResponse, err error)

GetBotTopns : Get Bot Analytics top attributes Get Bot Analytics top attributes for a given zone. Use this to view more detailed information on specific IP addresses and other characteristics.

func (*BotAnalyticsV1) GetBotTopnsWithContext 

func (botAnalytics *BotAnalyticsV1) GetBotTopnsWithContext(ctx context.Context, getBotTopnsOptions *GetBotTopnsOptions) (result *BotTopnsResp, response *core.DetailedResponse, err error)

GetBotTopnsWithContext is an alternate form of the GetBotTopns method which supports a Context parameter

func (*BotAnalyticsV1) GetEnableGzipCompression 

func (botAnalytics *BotAnalyticsV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*BotAnalyticsV1) GetServiceURL 

func (botAnalytics *BotAnalyticsV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*BotAnalyticsV1) NewGetBotScoreOptions 

func (*BotAnalyticsV1) NewGetBotScoreOptions(since *strfmt.DateTime, until *strfmt.DateTime) *GetBotScoreOptions

NewGetBotScoreOptions : Instantiate GetBotScoreOptions

func (*BotAnalyticsV1) NewGetBotTimeseriesOptions 

func (*BotAnalyticsV1) NewGetBotTimeseriesOptions(since *strfmt.DateTime, until *strfmt.DateTime) *GetBotTimeseriesOptions

NewGetBotTimeseriesOptions : Instantiate GetBotTimeseriesOptions

func (*BotAnalyticsV1) NewGetBotTopnsOptions 

func (*BotAnalyticsV1) NewGetBotTopnsOptions(since *strfmt.DateTime, until *strfmt.DateTime) *GetBotTopnsOptions

NewGetBotTopnsOptions : Instantiate GetBotTopnsOptions

func (*BotAnalyticsV1) SetDefaultHeaders 

func (botAnalytics *BotAnalyticsV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*BotAnalyticsV1) SetEnableGzipCompression 

func (botAnalytics *BotAnalyticsV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*BotAnalyticsV1) SetServiceURL 

func (botAnalytics *BotAnalyticsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type BotAnalyticsV1Options 

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

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

	// Zone identifier to identifiy the zone.
	ZoneIdentifier *string `validate:"required"`
}

BotAnalyticsV1Options : Service options

type BotScoreResp 

type BotScoreResp 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 []BotScoreRespResultItem `json:"result" validate:"required"`
}

BotScoreResp : Bot Score Source Response.

type BotScoreRespResultItem 

type BotScoreRespResultItem struct {
	BotScore []BotScoreRespResultItemBotScoreItem `json:"botScore,omitempty"`
}

BotScoreRespResultItem : BotScoreRespResultItem struct

type BotScoreRespResultItemBotScoreItem 

type BotScoreRespResultItemBotScoreItem struct {
	Avg *BotScoreRespResultItemBotScoreItemAvg `json:"avg,omitempty"`

	Count *float64 `json:"count,omitempty"`

	Dimensions *BotScoreRespResultItemBotScoreItemDimensions `json:"dimensions,omitempty"`
}

BotScoreRespResultItemBotScoreItem : BotScoreRespResultItemBotScoreItem struct

type BotScoreRespResultItemBotScoreItemAvg 

type BotScoreRespResultItemBotScoreItemAvg struct {
	SampleInterval *float64 `json:"sampleInterval,omitempty"`
}

BotScoreRespResultItemBotScoreItemAvg : BotScoreRespResultItemBotScoreItemAvg struct

type BotScoreRespResultItemBotScoreItemDimensions 

type BotScoreRespResultItemBotScoreItemDimensions struct {
	BotScoreSrcName *string `json:"botScoreSrcName,omitempty"`
}

BotScoreRespResultItemBotScoreItemDimensions : BotScoreRespResultItemBotScoreItemDimensions struct

type BotTimeseriesResp 

type BotTimeseriesResp 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 []map[string]interface{} `json:"result" validate:"required"`
}

BotTimeseriesResp : Bot Timeseries Response.

type BotTimeseriesRespResultItem 

type BotTimeseriesRespResultItem struct {
	BotScore []map[string]interface{} `json:"botScore,omitempty"`
}

BotTimeseriesRespResultItem : BotTimeseriesRespResultItem struct

type BotTopnsResp 

type BotTopnsResp 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 []map[string]interface{} `json:"result" validate:"required"`
}

BotTopnsResp : Bot top attributes response.

type GetBotScoreOptions 

type GetBotScoreOptions struct {
	// UTC datetime for start of query.
	Since *strfmt.DateTime `json:"since" validate:"required"`

	// UTC datetime for end of query.
	Until *strfmt.DateTime `json:"until" validate:"required"`

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

GetBotScoreOptions : The GetBotScore options.

func (*GetBotScoreOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetBotScoreOptions) SetSince 

func (_options *GetBotScoreOptions) SetSince(since *strfmt.DateTime) *GetBotScoreOptions

SetSince : Allow user to set Since

func (*GetBotScoreOptions) SetUntil 

func (_options *GetBotScoreOptions) SetUntil(until *strfmt.DateTime) *GetBotScoreOptions

SetUntil : Allow user to set Until

type GetBotTimeseriesOptions 

type GetBotTimeseriesOptions struct {
	// UTC datetime for start of query.
	Since *strfmt.DateTime `json:"since" validate:"required"`

	// UTC datetime for end of query.
	Until *strfmt.DateTime `json:"until" validate:"required"`

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

GetBotTimeseriesOptions : The GetBotTimeseries options.

func (*GetBotTimeseriesOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetBotTimeseriesOptions) SetSince 

func (_options *GetBotTimeseriesOptions) SetSince(since *strfmt.DateTime) *GetBotTimeseriesOptions

SetSince : Allow user to set Since

func (*GetBotTimeseriesOptions) SetUntil 

func (_options *GetBotTimeseriesOptions) SetUntil(until *strfmt.DateTime) *GetBotTimeseriesOptions

SetUntil : Allow user to set Until

type GetBotTopnsOptions 

type GetBotTopnsOptions struct {
	// UTC datetime for start of query.
	Since *strfmt.DateTime `json:"since" validate:"required"`

	// UTC datetime for end of query.
	Until *strfmt.DateTime `json:"until" validate:"required"`

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

GetBotTopnsOptions : The GetBotTopns options.

func (*GetBotTopnsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetBotTopnsOptions) SetSince 

func (_options *GetBotTopnsOptions) SetSince(since *strfmt.DateTime) *GetBotTopnsOptions

SetSince : Allow user to set Since

func (*GetBotTopnsOptions) SetUntil 

func (_options *GetBotTopnsOptions) SetUntil(until *strfmt.DateTime) *GetBotTopnsOptions

SetUntil : Allow user to set Until

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.