atrackerv2

package
v0.71.0 Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2024 License: Apache-2.0 Imports: 9 Imported by: 2

Documentation

Overview

Package atrackerv2 : Operations and models for the AtrackerV2 service

Index

Constants

View Source 
const (
	CreateTargetOptionsTargetTypeCloudLogsConst          = "cloud_logs"
	CreateTargetOptionsTargetTypeCloudObjectStorageConst = "cloud_object_storage"
	CreateTargetOptionsTargetTypeEventStreamsConst       = "event_streams"
	CreateTargetOptionsTargetTypeLogdnaConst             = "logdna"
)

Constants associated with the CreateTargetOptions.TargetType property. The type of the target. It can be cloud_object_storage, logdna, event_streams, or cloud_logs. Based on this type you must include cos_endpoint, logdna_endpoint, eventstreams_endpoint or cloudlogs_endpoint.

View Source 
const (
	TargetTargetTypeCloudLogsConst          = "cloud_logs"
	TargetTargetTypeCloudObjectStorageConst = "cloud_object_storage"
	TargetTargetTypeEventStreamsConst       = "event_streams"
	TargetTargetTypeLogdnaConst             = "logdna"
)

Constants associated with the Target.TargetType property. The type of the target.

View Source 
const DefaultServiceName = "atracker"

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

View Source 
const DefaultServiceURL = "https://us-south.atracker.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 UnmarshalCloudLogsEndpoint added in v0.62.1 

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

UnmarshalCloudLogsEndpoint unmarshals an instance of CloudLogsEndpoint from the specified map of raw messages.

func UnmarshalCloudLogsEndpointPrototype added in v0.62.1 

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

UnmarshalCloudLogsEndpointPrototype unmarshals an instance of CloudLogsEndpointPrototype from the specified map of raw messages.

func UnmarshalCosEndpoint 

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

UnmarshalCosEndpoint unmarshals an instance of CosEndpoint from the specified map of raw messages.

func UnmarshalCosEndpointPrototype 

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

UnmarshalCosEndpointPrototype unmarshals an instance of CosEndpointPrototype from the specified map of raw messages.

func UnmarshalEventstreamsEndpoint added in v0.28.3 

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

UnmarshalEventstreamsEndpoint unmarshals an instance of EventstreamsEndpoint from the specified map of raw messages.

func UnmarshalEventstreamsEndpointPrototype added in v0.28.3 

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

UnmarshalEventstreamsEndpointPrototype unmarshals an instance of EventstreamsEndpointPrototype from the specified map of raw messages.

func UnmarshalLogdnaEndpoint 

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

UnmarshalLogdnaEndpoint unmarshals an instance of LogdnaEndpoint from the specified map of raw messages.

func UnmarshalLogdnaEndpointPrototype 

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

UnmarshalLogdnaEndpointPrototype unmarshals an instance of LogdnaEndpointPrototype from the specified map of raw messages.

func UnmarshalRoute 

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

UnmarshalRoute unmarshals an instance of Route from the specified map of raw messages.

func UnmarshalRouteList 

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

UnmarshalRouteList unmarshals an instance of RouteList from the specified map of raw messages.

func UnmarshalRule 

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

UnmarshalRule unmarshals an instance of Rule from the specified map of raw messages.

func UnmarshalRulePrototype 

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

UnmarshalRulePrototype unmarshals an instance of RulePrototype from the specified map of raw messages.

func UnmarshalSettings 

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

UnmarshalSettings unmarshals an instance of Settings from the specified map of raw messages.

func UnmarshalTarget 

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

UnmarshalTarget unmarshals an instance of Target from the specified map of raw messages.

func UnmarshalTargetList 

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

UnmarshalTargetList unmarshals an instance of TargetList from the specified map of raw messages.

func UnmarshalWarning 

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

UnmarshalWarning unmarshals an instance of Warning from the specified map of raw messages.

func UnmarshalWarningReport 

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

UnmarshalWarningReport unmarshals an instance of WarningReport from the specified map of raw messages.

func UnmarshalWriteStatus 

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

UnmarshalWriteStatus unmarshals an instance of WriteStatus from the specified map of raw messages.

Types

type AtrackerV2 

type AtrackerV2 struct {
	Service *core.BaseService
}

AtrackerV2 : IBM Cloud Activity Tracker allows you to configure how auditing events are collected and stored in each region in your account. Events can be sent to Cloud Object Storage bucket, Logdna or Event Streams.

API Version: 2.0.0

func NewAtrackerV2 

func NewAtrackerV2(options *AtrackerV2Options) (service *AtrackerV2, err error)

NewAtrackerV2 : constructs an instance of AtrackerV2 with passed in options.

func NewAtrackerV2UsingExternalConfig 

func NewAtrackerV2UsingExternalConfig(options *AtrackerV2Options) (atracker *AtrackerV2, err error)

NewAtrackerV2UsingExternalConfig : constructs an instance of AtrackerV2 with passed in options and external configuration.

func (*AtrackerV2) Clone 

func (atracker *AtrackerV2) Clone() *AtrackerV2

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

func (*AtrackerV2) CreateRoute 

func (atracker *AtrackerV2) CreateRoute(createRouteOptions *CreateRouteOptions) (result *Route, response *core.DetailedResponse, err error)

CreateRoute : Create a route Create a route to define the rule that specifies how to manage auditing events.

func (*AtrackerV2) CreateRouteWithContext 

func (atracker *AtrackerV2) CreateRouteWithContext(ctx context.Context, createRouteOptions *CreateRouteOptions) (result *Route, response *core.DetailedResponse, err error)

CreateRouteWithContext is an alternate form of the CreateRoute method which supports a Context parameter

func (*AtrackerV2) CreateTarget 

func (atracker *AtrackerV2) CreateTarget(createTargetOptions *CreateTargetOptions) (result *Target, response *core.DetailedResponse, err error)

CreateTarget : Create a target Creates a target that includes information about the endpoint and the credentials required to write to that target. You can send your logs from all regions to a single target, different targets or multiple targets. One target per region is not required. You can define up to 16 targets per account.

func (*AtrackerV2) CreateTargetWithContext 

func (atracker *AtrackerV2) CreateTargetWithContext(ctx context.Context, createTargetOptions *CreateTargetOptions) (result *Target, response *core.DetailedResponse, err error)

CreateTargetWithContext is an alternate form of the CreateTarget method which supports a Context parameter

func (*AtrackerV2) DeleteRoute 

func (atracker *AtrackerV2) DeleteRoute(deleteRouteOptions *DeleteRouteOptions) (response *core.DetailedResponse, err error)

DeleteRoute : Delete a route Deletes a route.

func (*AtrackerV2) DeleteRouteWithContext 

func (atracker *AtrackerV2) DeleteRouteWithContext(ctx context.Context, deleteRouteOptions *DeleteRouteOptions) (response *core.DetailedResponse, err error)

DeleteRouteWithContext is an alternate form of the DeleteRoute method which supports a Context parameter

func (*AtrackerV2) DeleteTarget 

func (atracker *AtrackerV2) DeleteTarget(deleteTargetOptions *DeleteTargetOptions) (result *WarningReport, response *core.DetailedResponse, err error)

DeleteTarget : Delete a target Delete a target.

func (*AtrackerV2) DeleteTargetWithContext 

func (atracker *AtrackerV2) DeleteTargetWithContext(ctx context.Context, deleteTargetOptions *DeleteTargetOptions) (result *WarningReport, response *core.DetailedResponse, err error)

DeleteTargetWithContext is an alternate form of the DeleteTarget method which supports a Context parameter

func (*AtrackerV2) DisableRetries 

func (atracker *AtrackerV2) DisableRetries()

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

func (*AtrackerV2) EnableRetries 

func (atracker *AtrackerV2) 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 (*AtrackerV2) GetEnableGzipCompression 

func (atracker *AtrackerV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*AtrackerV2) GetRoute 

func (atracker *AtrackerV2) GetRoute(getRouteOptions *GetRouteOptions) (result *Route, response *core.DetailedResponse, err error)

GetRoute : Get details of a route Get the configuration details of a route.

func (*AtrackerV2) GetRouteWithContext 

func (atracker *AtrackerV2) GetRouteWithContext(ctx context.Context, getRouteOptions *GetRouteOptions) (result *Route, response *core.DetailedResponse, err error)

GetRouteWithContext is an alternate form of the GetRoute method which supports a Context parameter

func (*AtrackerV2) GetServiceURL 

func (atracker *AtrackerV2) GetServiceURL() string

GetServiceURL returns the service URL

func (*AtrackerV2) GetSettings 

func (atracker *AtrackerV2) GetSettings(getSettingsOptions *GetSettingsOptions) (result *Settings, response *core.DetailedResponse, err error)

GetSettings : Get settings Get information about the current settings including default targets.

func (*AtrackerV2) GetSettingsWithContext 

func (atracker *AtrackerV2) GetSettingsWithContext(ctx context.Context, getSettingsOptions *GetSettingsOptions) (result *Settings, response *core.DetailedResponse, err error)

GetSettingsWithContext is an alternate form of the GetSettings method which supports a Context parameter

func (*AtrackerV2) GetTarget 

func (atracker *AtrackerV2) GetTarget(getTargetOptions *GetTargetOptions) (result *Target, response *core.DetailedResponse, err error)

GetTarget : Get details of a target Retrieve the configuration details of a target.

func (*AtrackerV2) GetTargetWithContext 

func (atracker *AtrackerV2) GetTargetWithContext(ctx context.Context, getTargetOptions *GetTargetOptions) (result *Target, response *core.DetailedResponse, err error)

GetTargetWithContext is an alternate form of the GetTarget method which supports a Context parameter

func (*AtrackerV2) ListRoutes 

func (atracker *AtrackerV2) ListRoutes(listRoutesOptions *ListRoutesOptions) (result *RouteList, response *core.DetailedResponse, err error)

ListRoutes : List routes List the route that is configured for an account.

func (*AtrackerV2) ListRoutesWithContext 

func (atracker *AtrackerV2) ListRoutesWithContext(ctx context.Context, listRoutesOptions *ListRoutesOptions) (result *RouteList, response *core.DetailedResponse, err error)

ListRoutesWithContext is an alternate form of the ListRoutes method which supports a Context parameter

func (*AtrackerV2) ListTargets 

func (atracker *AtrackerV2) ListTargets(listTargetsOptions *ListTargetsOptions) (result *TargetList, response *core.DetailedResponse, err error)

ListTargets : List targets List all targets that are defined for your account.

func (*AtrackerV2) ListTargetsWithContext 

func (atracker *AtrackerV2) ListTargetsWithContext(ctx context.Context, listTargetsOptions *ListTargetsOptions) (result *TargetList, response *core.DetailedResponse, err error)

ListTargetsWithContext is an alternate form of the ListTargets method which supports a Context parameter

func (*AtrackerV2) NewCloudLogsEndpointPrototype added in v0.62.1 

func (*AtrackerV2) NewCloudLogsEndpointPrototype(targetCRN string) (_model *CloudLogsEndpointPrototype, err error)

NewCloudLogsEndpointPrototype : Instantiate CloudLogsEndpointPrototype (Generic Model Constructor)

func (*AtrackerV2) NewCosEndpointPrototype 

func (*AtrackerV2) NewCosEndpointPrototype(endpoint string, targetCRN string, bucket string) (_model *CosEndpointPrototype, err error)

NewCosEndpointPrototype : Instantiate CosEndpointPrototype (Generic Model Constructor)

func (*AtrackerV2) NewCreateRouteOptions 

func (*AtrackerV2) NewCreateRouteOptions(name string, rules []RulePrototype) *CreateRouteOptions

NewCreateRouteOptions : Instantiate CreateRouteOptions

func (*AtrackerV2) NewCreateTargetOptions 

func (*AtrackerV2) NewCreateTargetOptions(name string, targetType string) *CreateTargetOptions

NewCreateTargetOptions : Instantiate CreateTargetOptions

func (*AtrackerV2) NewDeleteRouteOptions 

func (*AtrackerV2) NewDeleteRouteOptions(id string) *DeleteRouteOptions

NewDeleteRouteOptions : Instantiate DeleteRouteOptions

func (*AtrackerV2) NewDeleteTargetOptions 

func (*AtrackerV2) NewDeleteTargetOptions(id string) *DeleteTargetOptions

NewDeleteTargetOptions : Instantiate DeleteTargetOptions

func (*AtrackerV2) NewEventstreamsEndpointPrototype added in v0.28.3 

func (*AtrackerV2) NewEventstreamsEndpointPrototype(targetCRN string, brokers []string, topic string) (_model *EventstreamsEndpointPrototype, err error)

NewEventstreamsEndpointPrototype : Instantiate EventstreamsEndpointPrototype (Generic Model Constructor)

func (*AtrackerV2) NewGetRouteOptions 

func (*AtrackerV2) NewGetRouteOptions(id string) *GetRouteOptions

NewGetRouteOptions : Instantiate GetRouteOptions

func (*AtrackerV2) NewGetSettingsOptions 

func (*AtrackerV2) NewGetSettingsOptions() *GetSettingsOptions

NewGetSettingsOptions : Instantiate GetSettingsOptions

func (*AtrackerV2) NewGetTargetOptions 

func (*AtrackerV2) NewGetTargetOptions(id string) *GetTargetOptions

NewGetTargetOptions : Instantiate GetTargetOptions

func (*AtrackerV2) NewListRoutesOptions 

func (*AtrackerV2) NewListRoutesOptions() *ListRoutesOptions

NewListRoutesOptions : Instantiate ListRoutesOptions

func (*AtrackerV2) NewListTargetsOptions 

func (*AtrackerV2) NewListTargetsOptions() *ListTargetsOptions

NewListTargetsOptions : Instantiate ListTargetsOptions

func (*AtrackerV2) NewLogdnaEndpointPrototype 

func (*AtrackerV2) NewLogdnaEndpointPrototype(targetCRN string, ingestionKey string) (_model *LogdnaEndpointPrototype, err error)

NewLogdnaEndpointPrototype : Instantiate LogdnaEndpointPrototype (Generic Model Constructor)

func (*AtrackerV2) NewPutSettingsOptions 

func (*AtrackerV2) NewPutSettingsOptions(metadataRegionPrimary string, privateAPIEndpointOnly bool) *PutSettingsOptions

NewPutSettingsOptions : Instantiate PutSettingsOptions

func (*AtrackerV2) NewReplaceRouteOptions 

func (*AtrackerV2) NewReplaceRouteOptions(id string, name string, rules []RulePrototype) *ReplaceRouteOptions

NewReplaceRouteOptions : Instantiate ReplaceRouteOptions

func (*AtrackerV2) NewReplaceTargetOptions 

func (*AtrackerV2) NewReplaceTargetOptions(id string) *ReplaceTargetOptions

NewReplaceTargetOptions : Instantiate ReplaceTargetOptions

func (*AtrackerV2) NewRulePrototype 

func (*AtrackerV2) NewRulePrototype(targetIds []string) (_model *RulePrototype, err error)

NewRulePrototype : Instantiate RulePrototype (Generic Model Constructor)

func (*AtrackerV2) NewValidateTargetOptions 

func (*AtrackerV2) NewValidateTargetOptions(id string) *ValidateTargetOptions

NewValidateTargetOptions : Instantiate ValidateTargetOptions

func (*AtrackerV2) PutSettings 

func (atracker *AtrackerV2) PutSettings(putSettingsOptions *PutSettingsOptions) (result *Settings, response *core.DetailedResponse, err error)

PutSettings : Modify settings Modify the current settings such as default targets, permitted target regions, metadata region primary and secondary.

func (*AtrackerV2) PutSettingsWithContext 

func (atracker *AtrackerV2) PutSettingsWithContext(ctx context.Context, putSettingsOptions *PutSettingsOptions) (result *Settings, response *core.DetailedResponse, err error)

PutSettingsWithContext is an alternate form of the PutSettings method which supports a Context parameter

func (*AtrackerV2) ReplaceRoute 

func (atracker *AtrackerV2) ReplaceRoute(replaceRouteOptions *ReplaceRouteOptions) (result *Route, response *core.DetailedResponse, err error)

ReplaceRoute : Update a route Update the configuration details of a route.

func (*AtrackerV2) ReplaceRouteWithContext 

func (atracker *AtrackerV2) ReplaceRouteWithContext(ctx context.Context, replaceRouteOptions *ReplaceRouteOptions) (result *Route, response *core.DetailedResponse, err error)

ReplaceRouteWithContext is an alternate form of the ReplaceRoute method which supports a Context parameter

func (*AtrackerV2) ReplaceTarget 

func (atracker *AtrackerV2) ReplaceTarget(replaceTargetOptions *ReplaceTargetOptions) (result *Target, response *core.DetailedResponse, err error)

ReplaceTarget : Update a target Update the configuration details of a target.

func (*AtrackerV2) ReplaceTargetWithContext 

func (atracker *AtrackerV2) ReplaceTargetWithContext(ctx context.Context, replaceTargetOptions *ReplaceTargetOptions) (result *Target, response *core.DetailedResponse, err error)

ReplaceTargetWithContext is an alternate form of the ReplaceTarget method which supports a Context parameter

func (*AtrackerV2) SetDefaultHeaders 

func (atracker *AtrackerV2) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*AtrackerV2) SetEnableGzipCompression 

func (atracker *AtrackerV2) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*AtrackerV2) SetServiceURL 

func (atracker *AtrackerV2) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*AtrackerV2) ValidateTarget 

func (atracker *AtrackerV2) ValidateTarget(validateTargetOptions *ValidateTargetOptions) (result *Target, response *core.DetailedResponse, err error)

ValidateTarget : Validate a target Validate a target by checking the credentials to write to the target. The result is included as additional data of the target in the section "write_status".

func (*AtrackerV2) ValidateTargetWithContext 

func (atracker *AtrackerV2) ValidateTargetWithContext(ctx context.Context, validateTargetOptions *ValidateTargetOptions) (result *Target, response *core.DetailedResponse, err error)

ValidateTargetWithContext is an alternate form of the ValidateTarget method which supports a Context parameter

type AtrackerV2Options 

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

AtrackerV2Options : Service options

type CloudLogsEndpoint added in v0.62.1 

type CloudLogsEndpoint struct {
	// The CRN of the IBM Cloud Logs instance.
	TargetCRN *string `json:"target_crn" validate:"required"`
}

CloudLogsEndpoint : Property values for the IBM Cloud Logs endpoint in responses.

type CloudLogsEndpointPrototype added in v0.62.1 

type CloudLogsEndpointPrototype struct {
	// The CRN of the IBM Cloud Logs instance.
	TargetCRN *string `json:"target_crn" validate:"required"`
}

CloudLogsEndpointPrototype : Property values for an IBM Cloud Logs endpoint in requests.

type CosEndpoint 

type CosEndpoint struct {
	// The host name of the Cloud Object Storage endpoint.
	Endpoint *string `json:"endpoint" validate:"required"`

	// The CRN of the Cloud Object Storage instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// The bucket name under the Cloud Object Storage instance.
	Bucket *string `json:"bucket" validate:"required"`

	// Determines if IBM Cloud Activity Tracker Event Routing has service to service authentication enabled. Set this flag
	// to true if service to service is enabled and do not supply an apikey.
	ServiceToServiceEnabled *bool `json:"service_to_service_enabled" validate:"required"`
}

CosEndpoint : Property values for a Cloud Object Storage Endpoint in responses.

type CosEndpointPrototype 

type CosEndpointPrototype struct {
	// The host name of the Cloud Object Storage endpoint.
	Endpoint *string `json:"endpoint" validate:"required"`

	// The CRN of the Cloud Object Storage instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// The bucket name under the Cloud Object Storage instance.
	Bucket *string `json:"bucket" validate:"required"`

	// The IAM API key that has writer access to the Cloud Object Storage instance. This credential is masked in the
	// response. This is required if service_to_service is not enabled.
	APIKey *string `json:"api_key,omitempty"`

	// Determines if IBM Cloud Activity Tracker Event Routing has service to service authentication enabled. Set this flag
	// to true if service to service is enabled and do not supply an apikey.
	ServiceToServiceEnabled *bool `json:"service_to_service_enabled,omitempty"`
}

CosEndpointPrototype : Property values for a Cloud Object Storage Endpoint in requests.

type CreateRouteOptions 

type CreateRouteOptions struct {
	// The name of the route. The name must be 1000 characters or less and cannot include any special characters other than
	// `(space) - . _ :`. Do not include any personal identifying information (PII) in any resource names.
	Name *string `json:"name" validate:"required"`

	// Routing rules that will be evaluated in their order of the array.
	Rules []RulePrototype `json:"rules" validate:"required"`

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

CreateRouteOptions : The CreateRoute options.

func (*CreateRouteOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateRouteOptions) SetName 

func (_options *CreateRouteOptions) SetName(name string) *CreateRouteOptions

SetName : Allow user to set Name

func (*CreateRouteOptions) SetRules 

func (_options *CreateRouteOptions) SetRules(rules []RulePrototype) *CreateRouteOptions

SetRules : Allow user to set Rules

type CreateTargetOptions 

type CreateTargetOptions struct {
	// The name of the target. The name must be 1000 characters or less, and cannot include any special characters other
	// than `(space) - . _ :`. Do not include any personal identifying information (PII) in any resource names.
	Name *string `json:"name" validate:"required"`

	// The type of the target. It can be cloud_object_storage, logdna, event_streams, or cloud_logs. Based on this type you
	// must include cos_endpoint, logdna_endpoint, eventstreams_endpoint or cloudlogs_endpoint.
	TargetType *string `json:"target_type" validate:"required"`

	// Property values for a Cloud Object Storage Endpoint in requests.
	CosEndpoint *CosEndpointPrototype `json:"cos_endpoint,omitempty"`

	// Property values for a LogDNA Endpoint in requests.
	LogdnaEndpoint *LogdnaEndpointPrototype `json:"logdna_endpoint,omitempty"`

	// Property values for an Event Streams Endpoint in requests.
	EventstreamsEndpoint *EventstreamsEndpointPrototype `json:"eventstreams_endpoint,omitempty"`

	// Property values for an IBM Cloud Logs endpoint in requests.
	CloudlogsEndpoint *CloudLogsEndpointPrototype `json:"cloudlogs_endpoint,omitempty"`

	// Include this optional field if you want to create a target in a different region other than the one you are
	// connected.
	Region *string `json:"region,omitempty"`

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

CreateTargetOptions : The CreateTarget options.

func (*CreateTargetOptions) SetCloudlogsEndpoint added in v0.62.1 

func (_options *CreateTargetOptions) SetCloudlogsEndpoint(cloudlogsEndpoint *CloudLogsEndpointPrototype) *CreateTargetOptions

SetCloudlogsEndpoint : Allow user to set CloudlogsEndpoint

func (*CreateTargetOptions) SetCosEndpoint 

func (_options *CreateTargetOptions) SetCosEndpoint(cosEndpoint *CosEndpointPrototype) *CreateTargetOptions

SetCosEndpoint : Allow user to set CosEndpoint

func (*CreateTargetOptions) SetEventstreamsEndpoint added in v0.28.3 

func (_options *CreateTargetOptions) SetEventstreamsEndpoint(eventstreamsEndpoint *EventstreamsEndpointPrototype) *CreateTargetOptions

SetEventstreamsEndpoint : Allow user to set EventstreamsEndpoint

func (*CreateTargetOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateTargetOptions) SetLogdnaEndpoint 

func (_options *CreateTargetOptions) SetLogdnaEndpoint(logdnaEndpoint *LogdnaEndpointPrototype) *CreateTargetOptions

SetLogdnaEndpoint : Allow user to set LogdnaEndpoint

func (*CreateTargetOptions) SetName 

func (_options *CreateTargetOptions) SetName(name string) *CreateTargetOptions

SetName : Allow user to set Name

func (*CreateTargetOptions) SetRegion 

func (_options *CreateTargetOptions) SetRegion(region string) *CreateTargetOptions

SetRegion : Allow user to set Region

func (*CreateTargetOptions) SetTargetType 

func (_options *CreateTargetOptions) SetTargetType(targetType string) *CreateTargetOptions

SetTargetType : Allow user to set TargetType

type DeleteRouteOptions 

type DeleteRouteOptions struct {
	// The v4 UUID that uniquely identifies the route.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteRouteOptions : The DeleteRoute options.

func (*DeleteRouteOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteRouteOptions) SetID 

func (_options *DeleteRouteOptions) SetID(id string) *DeleteRouteOptions

SetID : Allow user to set ID

type DeleteTargetOptions 

type DeleteTargetOptions struct {
	// The v4 UUID that uniquely identifies the target.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteTargetOptions : The DeleteTarget options.

func (*DeleteTargetOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteTargetOptions) SetID 

func (_options *DeleteTargetOptions) SetID(id string) *DeleteTargetOptions

SetID : Allow user to set ID

type EventstreamsEndpoint added in v0.28.3 

type EventstreamsEndpoint struct {
	// The CRN of the Event Streams instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// List of broker endpoints.
	Brokers []string `json:"brokers" validate:"required"`

	// The messsage hub topic defined in the Event Streams instance.
	Topic *string `json:"topic" validate:"required"`

	// The user password (api key) for the message hub topic in the Event Streams instance.
	APIKey *string `json:"api_key,omitempty"`

	// Determines if IBM Cloud Activity Tracker Event Routing has service to service authentication enabled. Set this flag
	// to true if service to service is enabled and do not supply an apikey.
	ServiceToServiceEnabled *bool `json:"service_to_service_enabled,omitempty"`
}

EventstreamsEndpoint : Property values for the Event Streams Endpoint in responses.

type EventstreamsEndpointPrototype added in v0.28.3 

type EventstreamsEndpointPrototype struct {
	// The CRN of the Event Streams instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// List of broker endpoints.
	Brokers []string `json:"brokers" validate:"required"`

	// The messsage hub topic defined in the Event Streams instance.
	Topic *string `json:"topic" validate:"required"`

	// The user password (api key) for the message hub topic in the Event Streams instance.
	APIKey *string `json:"api_key,omitempty"`

	// Determines if IBM Cloud Activity Tracker Event Routing has service to service authentication enabled. Set this flag
	// to true if service to service is enabled and do not supply an apikey.
	ServiceToServiceEnabled *bool `json:"service_to_service_enabled,omitempty"`
}

EventstreamsEndpointPrototype : Property values for an Event Streams Endpoint in requests.

type GetRouteOptions 

type GetRouteOptions struct {
	// The v4 UUID that uniquely identifies the route.
	ID *string `json:"id" validate:"required,ne="`

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

GetRouteOptions : The GetRoute options.

func (*GetRouteOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetRouteOptions) SetID 

func (_options *GetRouteOptions) SetID(id string) *GetRouteOptions

SetID : Allow user to set ID

type GetSettingsOptions 

type GetSettingsOptions struct {

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

GetSettingsOptions : The GetSettings options.

func (*GetSettingsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

type GetTargetOptions 

type GetTargetOptions struct {
	// The v4 UUID that uniquely identifies the target.
	ID *string `json:"id" validate:"required,ne="`

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

GetTargetOptions : The GetTarget options.

func (*GetTargetOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetTargetOptions) SetID 

func (_options *GetTargetOptions) SetID(id string) *GetTargetOptions

SetID : Allow user to set ID

type ListRoutesOptions 

type ListRoutesOptions struct {

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

ListRoutesOptions : The ListRoutes options.

func (*ListRoutesOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

type ListTargetsOptions 

type ListTargetsOptions struct {
	// Limit the query to the specified region.
	Region *string `json:"region,omitempty"`

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

ListTargetsOptions : The ListTargets options.

func (*ListTargetsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListTargetsOptions) SetRegion 

func (_options *ListTargetsOptions) SetRegion(region string) *ListTargetsOptions

SetRegion : Allow user to set Region

type LogdnaEndpoint 

type LogdnaEndpoint struct {
	// The CRN of the LogDNA instance.
	TargetCRN *string `json:"target_crn" validate:"required"`
}

LogdnaEndpoint : Property values for a LogDNA Endpoint in responses.

type LogdnaEndpointPrototype 

type LogdnaEndpointPrototype struct {
	// The CRN of the LogDNA instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// The LogDNA ingestion key is used for routing logs to a specific LogDNA instance.
	IngestionKey *string `json:"ingestion_key" validate:"required"`
}

LogdnaEndpointPrototype : Property values for a LogDNA Endpoint in requests.

type PutSettingsOptions 

type PutSettingsOptions struct {
	// To store all your meta data in a single region.
	MetadataRegionPrimary *string `json:"metadata_region_primary" validate:"required"`

	// If you set this true then you cannot access api through public network.
	PrivateAPIEndpointOnly *bool `json:"private_api_endpoint_only" validate:"required"`

	// The target ID List. In the event that no routing rule causes the event to be sent to a target, these targets will
	// receive the event.
	DefaultTargets []string `json:"default_targets,omitempty"`

	// If present then only these regions may be used to define a target.
	PermittedTargetRegions []string `json:"permitted_target_regions,omitempty"`

	// To store all your meta data in a backup region.
	MetadataRegionBackup *string `json:"metadata_region_backup,omitempty"`

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

PutSettingsOptions : The PutSettings options.

func (*PutSettingsOptions) SetDefaultTargets 

func (_options *PutSettingsOptions) SetDefaultTargets(defaultTargets []string) *PutSettingsOptions

SetDefaultTargets : Allow user to set DefaultTargets

func (*PutSettingsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*PutSettingsOptions) SetMetadataRegionBackup added in v0.28.1 

func (_options *PutSettingsOptions) SetMetadataRegionBackup(metadataRegionBackup string) *PutSettingsOptions

SetMetadataRegionBackup : Allow user to set MetadataRegionBackup

func (*PutSettingsOptions) SetMetadataRegionPrimary 

func (_options *PutSettingsOptions) SetMetadataRegionPrimary(metadataRegionPrimary string) *PutSettingsOptions

SetMetadataRegionPrimary : Allow user to set MetadataRegionPrimary

func (*PutSettingsOptions) SetPermittedTargetRegions 

func (_options *PutSettingsOptions) SetPermittedTargetRegions(permittedTargetRegions []string) *PutSettingsOptions

SetPermittedTargetRegions : Allow user to set PermittedTargetRegions

func (*PutSettingsOptions) SetPrivateAPIEndpointOnly 

func (_options *PutSettingsOptions) SetPrivateAPIEndpointOnly(privateAPIEndpointOnly bool) *PutSettingsOptions

SetPrivateAPIEndpointOnly : Allow user to set PrivateAPIEndpointOnly

type ReplaceRouteOptions 

type ReplaceRouteOptions struct {
	// The v4 UUID that uniquely identifies the route.
	ID *string `json:"id" validate:"required,ne="`

	// The name of the route. The name must be 1000 characters or less and cannot include any special characters other than
	// `(space) - . _ :`. Do not include any personal identifying information (PII) in any resource names.
	Name *string `json:"name" validate:"required"`

	// Routing rules that will be evaluated in their order of the array.
	Rules []RulePrototype `json:"rules" validate:"required"`

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

ReplaceRouteOptions : The ReplaceRoute options.

func (*ReplaceRouteOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ReplaceRouteOptions) SetID 

func (_options *ReplaceRouteOptions) SetID(id string) *ReplaceRouteOptions

SetID : Allow user to set ID

func (*ReplaceRouteOptions) SetName 

func (_options *ReplaceRouteOptions) SetName(name string) *ReplaceRouteOptions

SetName : Allow user to set Name

func (*ReplaceRouteOptions) SetRules 

func (_options *ReplaceRouteOptions) SetRules(rules []RulePrototype) *ReplaceRouteOptions

SetRules : Allow user to set Rules

type ReplaceTargetOptions 

type ReplaceTargetOptions struct {
	// The v4 UUID that uniquely identifies the target.
	ID *string `json:"id" validate:"required,ne="`

	// The name of the target. The name must be 1000 characters or less, and cannot include any special characters other
	// than `(space) - . _ :`. Do not include any personal identifying information (PII) in any resource names.
	Name *string `json:"name,omitempty"`

	// Property values for a Cloud Object Storage Endpoint in requests.
	CosEndpoint *CosEndpointPrototype `json:"cos_endpoint,omitempty"`

	// Property values for a LogDNA Endpoint in requests.
	LogdnaEndpoint *LogdnaEndpointPrototype `json:"logdna_endpoint,omitempty"`

	// Property values for an Event Streams Endpoint in requests.
	EventstreamsEndpoint *EventstreamsEndpointPrototype `json:"eventstreams_endpoint,omitempty"`

	// Property values for an IBM Cloud Logs endpoint in requests.
	CloudlogsEndpoint *CloudLogsEndpointPrototype `json:"cloudlogs_endpoint,omitempty"`

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

ReplaceTargetOptions : The ReplaceTarget options.

func (*ReplaceTargetOptions) SetCloudlogsEndpoint added in v0.62.1 

func (_options *ReplaceTargetOptions) SetCloudlogsEndpoint(cloudlogsEndpoint *CloudLogsEndpointPrototype) *ReplaceTargetOptions

SetCloudlogsEndpoint : Allow user to set CloudlogsEndpoint

func (*ReplaceTargetOptions) SetCosEndpoint 

func (_options *ReplaceTargetOptions) SetCosEndpoint(cosEndpoint *CosEndpointPrototype) *ReplaceTargetOptions

SetCosEndpoint : Allow user to set CosEndpoint

func (*ReplaceTargetOptions) SetEventstreamsEndpoint added in v0.28.3 

func (_options *ReplaceTargetOptions) SetEventstreamsEndpoint(eventstreamsEndpoint *EventstreamsEndpointPrototype) *ReplaceTargetOptions

SetEventstreamsEndpoint : Allow user to set EventstreamsEndpoint

func (*ReplaceTargetOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ReplaceTargetOptions) SetID 

func (_options *ReplaceTargetOptions) SetID(id string) *ReplaceTargetOptions

SetID : Allow user to set ID

func (*ReplaceTargetOptions) SetLogdnaEndpoint 

func (_options *ReplaceTargetOptions) SetLogdnaEndpoint(logdnaEndpoint *LogdnaEndpointPrototype) *ReplaceTargetOptions

SetLogdnaEndpoint : Allow user to set LogdnaEndpoint

func (*ReplaceTargetOptions) SetName 

func (_options *ReplaceTargetOptions) SetName(name string) *ReplaceTargetOptions

SetName : Allow user to set Name

type Route 

type Route struct {
	// The uuid of the route resource.
	ID *string `json:"id" validate:"required"`

	// The name of the route.
	Name *string `json:"name" validate:"required"`

	// The crn of the route resource.
	CRN *string `json:"crn" validate:"required"`

	// The version of the route.
	Version *int64 `json:"version,omitempty"`

	// The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in
	// the route definition will be skipped.
	Rules []Rule `json:"rules" validate:"required"`

	// The timestamp of the route creation time.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The timestamp of the route last updated time.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// The API version of the route.
	APIVersion *int64 `json:"api_version" validate:"required"`

	// An optional message containing information about the route.
	Message *string `json:"message,omitempty"`
}

Route : The route resource. The scope of the route is account wide. That means all the routes are evaluated in all regions, except the ones limited by region.

type RouteList 

type RouteList struct {
	// A list of route resources.
	Routes []Route `json:"routes" validate:"required"`
}

RouteList : A list of route resources.

type Rule 

type Rule struct {
	// The target ID List. All the events will be send to all targets listed in the rule. You can include targets from
	// other regions.
	TargetIds []string `json:"target_ids" validate:"required"`

	// Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global
	// and *.
	Locations []string `json:"locations" validate:"required"`
}

Rule : A configuration to route events to pre-defined target.

type RulePrototype 

type RulePrototype struct {
	// The target ID List. All the events will be send to all targets listed in the rule. You can include targets from
	// other regions.
	TargetIds []string `json:"target_ids" validate:"required"`

	// Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global
	// and *.
	Locations []string `json:"locations,omitempty"`
}

RulePrototype : A configuration to route events to pre-defined target.

type Settings 

type Settings struct {
	// The target ID List. In the event that no routing rule causes the event to be sent to a target, these targets will
	// receive the event.
	DefaultTargets []string `json:"default_targets" validate:"required"`

	// If present then only these regions may be used to define a target.
	PermittedTargetRegions []string `json:"permitted_target_regions" validate:"required"`

	// To store all your meta data in a single region.
	MetadataRegionPrimary *string `json:"metadata_region_primary" validate:"required"`

	// To store all your meta data in a backup region.
	MetadataRegionBackup *string `json:"metadata_region_backup,omitempty"`

	// If you set this true then you cannot access api through public network.
	PrivateAPIEndpointOnly *bool `json:"private_api_endpoint_only" validate:"required"`

	// API version used for configuring IBM Cloud Activity Tracker Event Routing resources in the account.
	APIVersion *int64 `json:"api_version" validate:"required"`

	// An optional message containing information about the audit log locations.
	Message *string `json:"message,omitempty"`
}

Settings : Activity Tracker Event Routing settings response.

type Target 

type Target struct {
	// The uuid of the target resource.
	ID *string `json:"id" validate:"required"`

	// The name of the target resource.
	Name *string `json:"name" validate:"required"`

	// The crn of the target resource.
	CRN *string `json:"crn" validate:"required"`

	// The type of the target.
	TargetType *string `json:"target_type" validate:"required"`

	// Included this optional field if you used it to create a target in a different region other than the one you are
	// connected.
	Region *string `json:"region,omitempty"`

	// Property values for a Cloud Object Storage Endpoint in responses.
	CosEndpoint *CosEndpoint `json:"cos_endpoint,omitempty"`

	// Property values for a LogDNA Endpoint in responses.
	LogdnaEndpoint *LogdnaEndpoint `json:"logdna_endpoint,omitempty"`

	// Property values for the Event Streams Endpoint in responses.
	EventstreamsEndpoint *EventstreamsEndpoint `json:"eventstreams_endpoint,omitempty"`

	// Property values for the IBM Cloud Logs endpoint in responses.
	CloudlogsEndpoint *CloudLogsEndpoint `json:"cloudlogs_endpoint,omitempty"`

	// The status of the write attempt to the target with the provided endpoint parameters.
	WriteStatus *WriteStatus `json:"write_status" validate:"required"`

	// The timestamp of the target creation time.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The timestamp of the target last updated time.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// An optional message containing information about the target.
	Message *string `json:"message,omitempty"`

	// The API version of the target.
	APIVersion *int64 `json:"api_version" validate:"required"`
}

Target : Property values for a target in responses.

type TargetList 

type TargetList struct {
	// A list of target resources.
	Targets []Target `json:"targets" validate:"required"`
}

TargetList : A list of target resources.

type ValidateTargetOptions 

type ValidateTargetOptions struct {
	// The v4 UUID that uniquely identifies the target.
	ID *string `json:"id" validate:"required,ne="`

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

ValidateTargetOptions : The ValidateTarget options.

func (*ValidateTargetOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ValidateTargetOptions) SetID 

func (_options *ValidateTargetOptions) SetID(id string) *ValidateTargetOptions

SetID : Allow user to set ID

type Warning 

type Warning struct {
	// The warning code.
	Code *string `json:"code" validate:"required"`

	// The warning message.
	Message *string `json:"message" validate:"required"`
}

Warning : The warning object.

type WarningReport 

type WarningReport struct {
	// The status code.
	StatusCode *int64 `json:"status_code,omitempty"`

	// The transaction-id of the API request.
	Trace *string `json:"trace,omitempty"`

	// The warning array triggered by the API request.
	Warnings []Warning `json:"warnings,omitempty"`
}

WarningReport : Description of a warning that occurred in a service request.

type WriteStatus 

type WriteStatus struct {
	// The status such as failed or success.
	Status *string `json:"status" validate:"required"`

	// The timestamp of the failure.
	LastFailure *strfmt.DateTime `json:"last_failure,omitempty"`

	// Detailed description of the cause of the failure.
	ReasonForLastFailure *string `json:"reason_for_last_failure,omitempty"`
}

WriteStatus : The status of the write attempt to the target with the provided endpoint parameters.

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.