Documentation ¶
Overview ¶
Package atrackerv1 : Operations and models for the AtrackerV1 service
Index ¶
- Constants
- func GetServiceURLForRegion(region string) (string, error)
- func UnmarshalCosEndpoint(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalRoute(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalRouteList(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalRule(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTarget(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTargetList(m map[string]json.RawMessage, result interface{}) (err error)
- type AtrackerV1
- func (atracker *AtrackerV1) Clone() *AtrackerV1
- func (atracker *AtrackerV1) CreateRoute(createRouteOptions *CreateRouteOptions) (result *Route, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) CreateRouteWithContext(ctx context.Context, createRouteOptions *CreateRouteOptions) (result *Route, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) CreateTarget(createTargetOptions *CreateTargetOptions) (result *Target, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) CreateTargetWithContext(ctx context.Context, createTargetOptions *CreateTargetOptions) (result *Target, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) DeleteRoute(deleteRouteOptions *DeleteRouteOptions) (response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) DeleteRouteWithContext(ctx context.Context, deleteRouteOptions *DeleteRouteOptions) (response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) DeleteTarget(deleteTargetOptions *DeleteTargetOptions) (response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) DeleteTargetWithContext(ctx context.Context, deleteTargetOptions *DeleteTargetOptions) (response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) DisableRetries()
- func (atracker *AtrackerV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
- func (atracker *AtrackerV1) GetEnableGzipCompression() bool
- func (atracker *AtrackerV1) GetRoute(getRouteOptions *GetRouteOptions) (result *Route, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) GetRouteWithContext(ctx context.Context, getRouteOptions *GetRouteOptions) (result *Route, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) GetServiceURL() string
- func (atracker *AtrackerV1) GetTarget(getTargetOptions *GetTargetOptions) (result *Target, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) GetTargetWithContext(ctx context.Context, getTargetOptions *GetTargetOptions) (result *Target, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) ListRoutes(listRoutesOptions *ListRoutesOptions) (result *RouteList, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) ListRoutesWithContext(ctx context.Context, listRoutesOptions *ListRoutesOptions) (result *RouteList, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) ListTargets(listTargetsOptions *ListTargetsOptions) (result *TargetList, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) ListTargetsWithContext(ctx context.Context, listTargetsOptions *ListTargetsOptions) (result *TargetList, response *core.DetailedResponse, err error)
- func (*AtrackerV1) NewCosEndpoint(endpoint string, targetCRN string, bucket string, apiKey string) (model *CosEndpoint, err error)
- func (*AtrackerV1) NewCreateRouteOptions(name string, receiveGlobalEvents bool, rules []Rule) *CreateRouteOptions
- func (*AtrackerV1) NewCreateTargetOptions(name string, targetType string, cosEndpoint *CosEndpoint) *CreateTargetOptions
- func (*AtrackerV1) NewDeleteRouteOptions(id string) *DeleteRouteOptions
- func (*AtrackerV1) NewDeleteTargetOptions(id string) *DeleteTargetOptions
- func (*AtrackerV1) NewGetRouteOptions(id string) *GetRouteOptions
- func (*AtrackerV1) NewGetTargetOptions(id string) *GetTargetOptions
- func (*AtrackerV1) NewListRoutesOptions() *ListRoutesOptions
- func (*AtrackerV1) NewListTargetsOptions() *ListTargetsOptions
- func (*AtrackerV1) NewReplaceRouteOptions(id string, name string, receiveGlobalEvents bool, rules []Rule) *ReplaceRouteOptions
- func (*AtrackerV1) NewReplaceTargetOptions(id string, name string, targetType string, cosEndpoint *CosEndpoint) *ReplaceTargetOptions
- func (*AtrackerV1) NewRule(targetIds []string) (model *Rule, err error)
- func (atracker *AtrackerV1) ReplaceRoute(replaceRouteOptions *ReplaceRouteOptions) (result *Route, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) ReplaceRouteWithContext(ctx context.Context, replaceRouteOptions *ReplaceRouteOptions) (result *Route, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) ReplaceTarget(replaceTargetOptions *ReplaceTargetOptions) (result *Target, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) ReplaceTargetWithContext(ctx context.Context, replaceTargetOptions *ReplaceTargetOptions) (result *Target, response *core.DetailedResponse, err error)
- func (atracker *AtrackerV1) SetDefaultHeaders(headers http.Header)
- func (atracker *AtrackerV1) SetEnableGzipCompression(enableGzip bool)
- func (atracker *AtrackerV1) SetServiceURL(url string) error
- type AtrackerV1Options
- type CosEndpoint
- type CreateRouteOptions
- func (options *CreateRouteOptions) SetHeaders(param map[string]string) *CreateRouteOptions
- func (options *CreateRouteOptions) SetName(name string) *CreateRouteOptions
- func (options *CreateRouteOptions) SetReceiveGlobalEvents(receiveGlobalEvents bool) *CreateRouteOptions
- func (options *CreateRouteOptions) SetRules(rules []Rule) *CreateRouteOptions
- type CreateTargetOptions
- func (options *CreateTargetOptions) SetCosEndpoint(cosEndpoint *CosEndpoint) *CreateTargetOptions
- func (options *CreateTargetOptions) SetHeaders(param map[string]string) *CreateTargetOptions
- func (options *CreateTargetOptions) SetName(name string) *CreateTargetOptions
- func (options *CreateTargetOptions) SetTargetType(targetType string) *CreateTargetOptions
- type DeleteRouteOptions
- type DeleteTargetOptions
- type GetRouteOptions
- type GetTargetOptions
- type ListRoutesOptions
- type ListTargetsOptions
- type ReplaceRouteOptions
- func (options *ReplaceRouteOptions) SetHeaders(param map[string]string) *ReplaceRouteOptions
- func (options *ReplaceRouteOptions) SetID(id string) *ReplaceRouteOptions
- func (options *ReplaceRouteOptions) SetName(name string) *ReplaceRouteOptions
- func (options *ReplaceRouteOptions) SetReceiveGlobalEvents(receiveGlobalEvents bool) *ReplaceRouteOptions
- func (options *ReplaceRouteOptions) SetRules(rules []Rule) *ReplaceRouteOptions
- type ReplaceTargetOptions
- func (options *ReplaceTargetOptions) SetCosEndpoint(cosEndpoint *CosEndpoint) *ReplaceTargetOptions
- func (options *ReplaceTargetOptions) SetHeaders(param map[string]string) *ReplaceTargetOptions
- func (options *ReplaceTargetOptions) SetID(id string) *ReplaceTargetOptions
- func (options *ReplaceTargetOptions) SetName(name string) *ReplaceTargetOptions
- func (options *ReplaceTargetOptions) SetTargetType(targetType string) *ReplaceTargetOptions
- type Route
- type RouteList
- type Rule
- type Target
- type TargetList
Constants ¶
const (
CreateTargetOptionsTargetTypeCloudObjectStorageConst = "cloud_object_storage"
)
Constants associated with the CreateTargetOptions.TargetType property. The type of the target.
const DefaultServiceName = "atracker"
DefaultServiceName is the default key used to find external configuration information.
const DefaultServiceURL = "https://private.us-south.atracker.cloud.ibm.com"
DefaultServiceURL is the default URL to make service requests to.
const (
ReplaceTargetOptionsTargetTypeCloudObjectStorageConst = "cloud_object_storage"
)
Constants associated with the ReplaceTargetOptions.TargetType property. The type of the target.
const (
TargetTargetTypeCloudObjectStorageConst = "cloud_object_storage"
)
Constants associated with the Target.TargetType property. The type of this target.
Variables ¶
This section is empty.
Functions ¶
func GetServiceURLForRegion ¶ added in v0.15.3
GetServiceURLForRegion returns the service URL to be used for the specified region
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 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 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.
Types ¶
type AtrackerV1 ¶
type AtrackerV1 struct {
Service *core.BaseService
}
AtrackerV1 : IBM Cloud Activity Tracking Service (ATracker Service for short) is an activity tracker configuration service for your application events as well as events from IBM services under your account. It is designed to enable you to route activity tracker events to your designated Cloud Object Storage location in different regions.
Version: 1.0.0
func NewAtrackerV1 ¶
func NewAtrackerV1(options *AtrackerV1Options) (service *AtrackerV1, err error)
NewAtrackerV1 : constructs an instance of AtrackerV1 with passed in options.
func NewAtrackerV1UsingExternalConfig ¶
func NewAtrackerV1UsingExternalConfig(options *AtrackerV1Options) (atracker *AtrackerV1, err error)
NewAtrackerV1UsingExternalConfig : constructs an instance of AtrackerV1 with passed in options and external configuration.
func (*AtrackerV1) Clone ¶ added in v0.17.1
func (atracker *AtrackerV1) Clone() *AtrackerV1
Clone makes a copy of "atracker" suitable for processing requests.
func (*AtrackerV1) CreateRoute ¶
func (atracker *AtrackerV1) CreateRoute(createRouteOptions *CreateRouteOptions) (result *Route, response *core.DetailedResponse, err error)
CreateRoute : Create a Route for the region Creates a route with rules defined how to route AT events to targets for a region. For each account and region, only one route could be defined. A route could contain multiple rules which enable atracker service to match incoming AT events based on the source crn and forward the events to customer configured targets.
func (*AtrackerV1) CreateRouteWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) CreateTarget ¶
func (atracker *AtrackerV1) CreateTarget(createTargetOptions *CreateTargetOptions) (result *Target, response *core.DetailedResponse, err error)
CreateTarget : Create a Cloud Object Storage target for a region Creates a new Cloud Object Storage (COS) target with specified COS endpoint information and credentials. Commonly the COS endpoint should be on the same region as ATracker Services where this API is invoked. The Target definition could only be referenced by the routing rules defined in the same region through the same API endpoint. If a COS endpoint to be used across multiple regions, you must define a target for each region's API endpoint.
func (*AtrackerV1) CreateTargetWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) DeleteRoute ¶
func (atracker *AtrackerV1) DeleteRoute(deleteRouteOptions *DeleteRouteOptions) (response *core.DetailedResponse, err error)
DeleteRoute : Delete a route Deletes a route by specifying the ID of the route.
func (*AtrackerV1) DeleteRouteWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) DeleteTarget ¶
func (atracker *AtrackerV1) DeleteTarget(deleteTargetOptions *DeleteTargetOptions) (response *core.DetailedResponse, err error)
DeleteTarget : Delete a target Deletes a target by specifying the ID of the target.
func (*AtrackerV1) DeleteTargetWithContext ¶
func (atracker *AtrackerV1) DeleteTargetWithContext(ctx context.Context, deleteTargetOptions *DeleteTargetOptions) (response *core.DetailedResponse, err error)
DeleteTargetWithContext is an alternate form of the DeleteTarget method which supports a Context parameter
func (*AtrackerV1) DisableRetries ¶
func (atracker *AtrackerV1) DisableRetries()
DisableRetries disables automatic retries for requests invoked for this service instance.
func (*AtrackerV1) EnableRetries ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) GetEnableGzipCompression ¶
func (atracker *AtrackerV1) GetEnableGzipCompression() bool
GetEnableGzipCompression returns the service's EnableGzipCompression field
func (*AtrackerV1) GetRoute ¶
func (atracker *AtrackerV1) GetRoute(getRouteOptions *GetRouteOptions) (result *Route, response *core.DetailedResponse, err error)
GetRoute : Retrieve a route Retrieves a route and its details by specifying the ID of the route.
func (*AtrackerV1) GetRouteWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) GetServiceURL ¶
func (atracker *AtrackerV1) GetServiceURL() string
GetServiceURL returns the service URL
func (*AtrackerV1) GetTarget ¶
func (atracker *AtrackerV1) GetTarget(getTargetOptions *GetTargetOptions) (result *Target, response *core.DetailedResponse, err error)
GetTarget : Retrieve a target Retrieves a target and its details by specifying the ID of the target.
func (*AtrackerV1) GetTargetWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) ListRoutes ¶
func (atracker *AtrackerV1) ListRoutes(listRoutesOptions *ListRoutesOptions) (result *RouteList, response *core.DetailedResponse, err error)
ListRoutes : List routes for the region List routes defined under this region.
func (*AtrackerV1) ListRoutesWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) ListTargets ¶
func (atracker *AtrackerV1) ListTargets(listTargetsOptions *ListTargetsOptions) (result *TargetList, response *core.DetailedResponse, err error)
ListTargets : List Cloud Object Storage targets for the region List all Cloud Object Storage (COS) targets defined under this region.
func (*AtrackerV1) ListTargetsWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) NewCosEndpoint ¶
func (*AtrackerV1) NewCosEndpoint(endpoint string, targetCRN string, bucket string, apiKey string) (model *CosEndpoint, err error)
NewCosEndpoint : Instantiate CosEndpoint (Generic Model Constructor)
func (*AtrackerV1) NewCreateRouteOptions ¶
func (*AtrackerV1) NewCreateRouteOptions(name string, receiveGlobalEvents bool, rules []Rule) *CreateRouteOptions
NewCreateRouteOptions : Instantiate CreateRouteOptions
func (*AtrackerV1) NewCreateTargetOptions ¶
func (*AtrackerV1) NewCreateTargetOptions(name string, targetType string, cosEndpoint *CosEndpoint) *CreateTargetOptions
NewCreateTargetOptions : Instantiate CreateTargetOptions
func (*AtrackerV1) NewDeleteRouteOptions ¶
func (*AtrackerV1) NewDeleteRouteOptions(id string) *DeleteRouteOptions
NewDeleteRouteOptions : Instantiate DeleteRouteOptions
func (*AtrackerV1) NewDeleteTargetOptions ¶
func (*AtrackerV1) NewDeleteTargetOptions(id string) *DeleteTargetOptions
NewDeleteTargetOptions : Instantiate DeleteTargetOptions
func (*AtrackerV1) NewGetRouteOptions ¶
func (*AtrackerV1) NewGetRouteOptions(id string) *GetRouteOptions
NewGetRouteOptions : Instantiate GetRouteOptions
func (*AtrackerV1) NewGetTargetOptions ¶
func (*AtrackerV1) NewGetTargetOptions(id string) *GetTargetOptions
NewGetTargetOptions : Instantiate GetTargetOptions
func (*AtrackerV1) NewListRoutesOptions ¶
func (*AtrackerV1) NewListRoutesOptions() *ListRoutesOptions
NewListRoutesOptions : Instantiate ListRoutesOptions
func (*AtrackerV1) NewListTargetsOptions ¶
func (*AtrackerV1) NewListTargetsOptions() *ListTargetsOptions
NewListTargetsOptions : Instantiate ListTargetsOptions
func (*AtrackerV1) NewReplaceRouteOptions ¶
func (*AtrackerV1) NewReplaceRouteOptions(id string, name string, receiveGlobalEvents bool, rules []Rule) *ReplaceRouteOptions
NewReplaceRouteOptions : Instantiate ReplaceRouteOptions
func (*AtrackerV1) NewReplaceTargetOptions ¶
func (*AtrackerV1) NewReplaceTargetOptions(id string, name string, targetType string, cosEndpoint *CosEndpoint) *ReplaceTargetOptions
NewReplaceTargetOptions : Instantiate ReplaceTargetOptions
func (*AtrackerV1) NewRule ¶
func (*AtrackerV1) NewRule(targetIds []string) (model *Rule, err error)
NewRule : Instantiate Rule (Generic Model Constructor)
func (*AtrackerV1) ReplaceRoute ¶
func (atracker *AtrackerV1) ReplaceRoute(replaceRouteOptions *ReplaceRouteOptions) (result *Route, response *core.DetailedResponse, err error)
ReplaceRoute : Replace a route Replace a route details by specifying the ID of the route.
func (*AtrackerV1) ReplaceRouteWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) ReplaceTarget ¶
func (atracker *AtrackerV1) ReplaceTarget(replaceTargetOptions *ReplaceTargetOptions) (result *Target, response *core.DetailedResponse, err error)
ReplaceTarget : Update a target Update a target details by specifying the ID of the target.
func (*AtrackerV1) ReplaceTargetWithContext ¶
func (atracker *AtrackerV1) 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 (*AtrackerV1) SetDefaultHeaders ¶
func (atracker *AtrackerV1) SetDefaultHeaders(headers http.Header)
SetDefaultHeaders sets HTTP headers to be sent in every request
func (*AtrackerV1) SetEnableGzipCompression ¶
func (atracker *AtrackerV1) SetEnableGzipCompression(enableGzip bool)
SetEnableGzipCompression sets the service's EnableGzipCompression field
func (*AtrackerV1) SetServiceURL ¶
func (atracker *AtrackerV1) SetServiceURL(url string) error
SetServiceURL sets the service URL
type AtrackerV1Options ¶
type AtrackerV1Options struct { ServiceName string URL string Authenticator core.Authenticator }
AtrackerV1Options : Service options
type CosEndpoint ¶
type CosEndpoint struct { // The host name of this COS endpoint. Endpoint *string `json:"endpoint" validate:"required"` // The CRN of this COS instance. TargetCRN *string `json:"target_crn" validate:"required"` // The bucket name under this COS instance. Bucket *string `json:"bucket" validate:"required"` // The IAM Api key that have writer access to this cos instance. This credential will be masked in the response. APIKey *string `json:"api_key" validate:"required"` }
CosEndpoint : Property values for a Cloud Object Storage Endpoint.
type CreateRouteOptions ¶
type CreateRouteOptions struct { // The name of the route. Must be 180 characters or less and cannot include any special characters other than `(space) // - . _ :`. Name *string `validate:"required"` // Whether or not all global events should be forwarded to this region. ReceiveGlobalEvents *bool `validate:"required"` // Routing rules that will be evaluated in their order of the array. Rules []Rule `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) SetReceiveGlobalEvents ¶
func (options *CreateRouteOptions) SetReceiveGlobalEvents(receiveGlobalEvents bool) *CreateRouteOptions
SetReceiveGlobalEvents : Allow user to set ReceiveGlobalEvents
func (*CreateRouteOptions) SetRules ¶
func (options *CreateRouteOptions) SetRules(rules []Rule) *CreateRouteOptions
SetRules : Allow user to set Rules
type CreateTargetOptions ¶
type CreateTargetOptions struct { // The name of the target. Must be 256 characters or less. Name *string `validate:"required"` // The type of the target. TargetType *string `validate:"required"` // Property values for a Cloud Object Storage Endpoint. CosEndpoint *CosEndpoint `validate:"required"` // Allows users to set headers on API requests Headers map[string]string }
CreateTargetOptions : The CreateTarget options.
func (*CreateTargetOptions) SetCosEndpoint ¶
func (options *CreateTargetOptions) SetCosEndpoint(cosEndpoint *CosEndpoint) *CreateTargetOptions
SetCosEndpoint : Allow user to set CosEndpoint
func (*CreateTargetOptions) SetHeaders ¶
func (options *CreateTargetOptions) SetHeaders(param map[string]string) *CreateTargetOptions
SetHeaders : Allow user to set Headers
func (*CreateTargetOptions) SetName ¶
func (options *CreateTargetOptions) SetName(name string) *CreateTargetOptions
SetName : Allow user to set Name
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 `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 `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 GetRouteOptions ¶
type GetRouteOptions struct { // The v4 UUID that uniquely identifies the route. ID *string `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 GetTargetOptions ¶
type GetTargetOptions struct { // The v4 UUID that uniquely identifies the target. ID *string `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 { // 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
type ReplaceRouteOptions ¶
type ReplaceRouteOptions struct { // The v4 UUID that uniquely identifies the route. ID *string `validate:"required,ne="` // The name of the route. Must be 180 characters or less and cannot include any special characters other than `(space) // - . _ :`. Name *string `validate:"required"` // Whether or not all global events should be forwarded to this region. ReceiveGlobalEvents *bool `validate:"required"` // Routing rules that will be evaluated in their order of the array. Rules []Rule `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) SetReceiveGlobalEvents ¶
func (options *ReplaceRouteOptions) SetReceiveGlobalEvents(receiveGlobalEvents bool) *ReplaceRouteOptions
SetReceiveGlobalEvents : Allow user to set ReceiveGlobalEvents
func (*ReplaceRouteOptions) SetRules ¶
func (options *ReplaceRouteOptions) SetRules(rules []Rule) *ReplaceRouteOptions
SetRules : Allow user to set Rules
type ReplaceTargetOptions ¶
type ReplaceTargetOptions struct { // The v4 UUID that uniquely identifies the target. ID *string `validate:"required,ne="` // The name of the target. Must be 256 characters or less. Name *string `validate:"required"` // The type of the target. TargetType *string `validate:"required"` // Property values for a Cloud Object Storage Endpoint. CosEndpoint *CosEndpoint `validate:"required"` // Allows users to set headers on API requests Headers map[string]string }
ReplaceTargetOptions : The ReplaceTarget options.
func (*ReplaceTargetOptions) SetCosEndpoint ¶
func (options *ReplaceTargetOptions) SetCosEndpoint(cosEndpoint *CosEndpoint) *ReplaceTargetOptions
SetCosEndpoint : Allow user to set CosEndpoint
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) SetName ¶
func (options *ReplaceTargetOptions) SetName(name string) *ReplaceTargetOptions
SetName : Allow user to set Name
func (*ReplaceTargetOptions) SetTargetType ¶
func (options *ReplaceTargetOptions) SetTargetType(targetType string) *ReplaceTargetOptions
SetTargetType : Allow user to set TargetType
type Route ¶
type Route struct { // The uuid of this route resource. ID *string `json:"id" validate:"required"` // The name of this route. Name *string `json:"name" validate:"required"` // The crn of this route type resource. CRN *string `json:"crn" validate:"required"` // The version of this route. Version *int64 `json:"version,omitempty"` // Whether or not all global events should be forwarded to this region. ReceiveGlobalEvents *bool `json:"receive_global_events" validate:"required"` // The routing rules that will be evaluated in their order of the array. Rules []Rule `json:"rules" validate:"required"` }
Route : The route resource.
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. Only one target id is supported. TargetIds []string `json:"target_ids" validate:"required"` }
Rule : The request payload to create a regional route.
type Target ¶
type Target struct { // The uuid of this target resource. ID *string `json:"id" validate:"required"` // The name of this target resource. Name *string `json:"name" validate:"required"` // The crn of this target type resource. CRN *string `json:"crn" validate:"required"` // The type of this target. TargetType *string `json:"target_type" validate:"required"` // The encryption key used to encrypt events before ATracker services buffer them on storage. This credential will be // masked in the response. EncryptKey *string `json:"encrypt_key,omitempty"` // Property values for a Cloud Object Storage Endpoint. CosEndpoint *CosEndpoint `json:"cos_endpoint,omitempty"` }
Target : Property values for a target in response. Credentials associated with the target are encrypted and masked as REDACTED in the response.
type TargetList ¶
type TargetList struct { // A list of target resources. Targets []Target `json:"targets" validate:"required"` }
TargetList : A list of target resources.