atrackerv1

package
v0.35.1 Latest Latest
Warning

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

 Go to latest Published: Apr 5, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package atrackerv1 : Operations and models for the AtrackerV1 service

Index

Constants

View Source 
const (
	CreateTargetOptionsTargetTypeCloudObjectStorageConst = "cloud_object_storage"
)

Constants associated with the CreateTargetOptions.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.

View Source 
const (
	ReplaceTargetOptionsTargetTypeCloudObjectStorageConst = "cloud_object_storage"
)

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

View Source 
const (
	TargetTargetTypeCloudObjectStorageConst = "cloud_object_storage"
)

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

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.15.3 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalAPIEndpoint added in v0.19.1 

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

UnmarshalAPIEndpoint unmarshals an instance of APIEndpoint 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 UnmarshalCosWriteStatus added in v0.18.17 

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

UnmarshalCosWriteStatus unmarshals an instance of CosWriteStatus from the specified map of raw messages.

func UnmarshalEndpoints added in v0.19.1 

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

UnmarshalEndpoints unmarshals an instance of Endpoints from the specified map of raw messages.

func UnmarshalEndpointsRequestAPIEndpoint added in v0.19.1 

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

UnmarshalEndpointsRequestAPIEndpoint unmarshals an instance of EndpointsRequestAPIEndpoint 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.

func UnmarshalWarning added in v0.18.17 

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

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

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

Types

type APIEndpoint added in v0.19.1 

type APIEndpoint struct {
	// The public URL of Activity Tracker in a region.
	PublicURL *string `json:"public_url" validate:"required"`

	// Indicates whether or not the public endpoint is enabled in the account.
	PublicEnabled *bool `json:"public_enabled" validate:"required"`

	// The private URL of Activity Tracker. This URL cannot be disabled.
	PrivateURL *string `json:"private_url" validate:"required"`

	// The private endpoint is always enabled.
	PrivateEnabled *bool `json:"private_enabled,omitempty"`
}

APIEndpoint : Activity Tracker API endpoint.

type AtrackerV1 

type AtrackerV1 struct {
	Service *core.BaseService
}

AtrackerV1 : IBM Cloud Activity Tracker Event Routing allows you to configure how auditing events are collected and stored in each region in your account. Events are stored in a Cloud Object Storage bucket that is also available in the account.

API Version: 1.1.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 Create a route to define the rule that specifies how to manage auditing events in a region. You can define 1 route only per region. You can configure 1 target only per route. To define how to manage global events, that is, auditing events in your account that are not region specific, you must configure 1 route in your account to collect and route global events. You must set the receive_global_events field to true.

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 target Creates a Cloud Object Storage (COS) target that includes information about the COS endpoint and the credentials to access the bucket. You must define a COS target per region. Notice that although you can use the same COS bucket for collecting auditing events in your account across multiple regions, you should consider defining a bucket in each region to reduce performance and network latency issues. You can define up to 16 targets per region.

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.

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) (result *WarningReport, response *core.DetailedResponse, err error)

DeleteTarget : Delete a target Delete a target.

func (*AtrackerV1) DeleteTargetWithContext 

func (atracker *AtrackerV1) 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 (*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) GetEndpoints added in v0.19.1 

func (atracker *AtrackerV1) GetEndpoints(getEndpointsOptions *GetEndpointsOptions) (result *Endpoints, response *core.DetailedResponse, err error)

GetEndpoints : Get endpoints Get information about the public and private endpoints that are enabled in a region when you use the Activity Tracker API.

func (*AtrackerV1) GetEndpointsWithContext added in v0.19.1 

func (atracker *AtrackerV1) GetEndpointsWithContext(ctx context.Context, getEndpointsOptions *GetEndpointsOptions) (result *Endpoints, response *core.DetailedResponse, err error)

GetEndpointsWithContext is an alternate form of the GetEndpoints method which supports a Context parameter

func (*AtrackerV1) GetRoute 

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

GetRoute : Get details of a route Get the configuration details of a 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 : Get details of a target Retrieve the configuration details of a 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 List the route that is configured in a 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 targets List all Cloud Object Storage (COS) targets that are defined in a 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) NewGetEndpointsOptions added in v0.19.1 

func (*AtrackerV1) NewGetEndpointsOptions() *GetEndpointsOptions

NewGetEndpointsOptions : Instantiate GetEndpointsOptions

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) NewPatchEndpointsOptions added in v0.19.1 

func (*AtrackerV1) NewPatchEndpointsOptions() *PatchEndpointsOptions

NewPatchEndpointsOptions : Instantiate PatchEndpointsOptions

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) NewValidateTargetOptions added in v0.18.17 

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

NewValidateTargetOptions : Instantiate ValidateTargetOptions

func (*AtrackerV1) PatchEndpoints added in v0.19.1 

func (atracker *AtrackerV1) PatchEndpoints(patchEndpointsOptions *PatchEndpointsOptions) (result *Endpoints, response *core.DetailedResponse, err error)

PatchEndpoints : Modify endpoints Configure the public endpoint availability in a region to use the Activity Tracker API. By default, the private endpoint is enabled and cannot be disabled.

func (*AtrackerV1) PatchEndpointsWithContext added in v0.19.1 

func (atracker *AtrackerV1) PatchEndpointsWithContext(ctx context.Context, patchEndpointsOptions *PatchEndpointsOptions) (result *Endpoints, response *core.DetailedResponse, err error)

PatchEndpointsWithContext is an alternate form of the PatchEndpoints method which supports a Context parameter

func (*AtrackerV1) ReplaceRoute 

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

ReplaceRoute : Update a route Update the configuration details of a 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 the configuration details of a 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

func (*AtrackerV1) ValidateTarget added in v0.18.17 

func (atracker *AtrackerV1) 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 bucket. The result is included as additional data of the target in the section "cos_write_status".

func (*AtrackerV1) ValidateTargetWithContext added in v0.18.17 

func (atracker *AtrackerV1) 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 AtrackerV1Options 

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

AtrackerV1Options : Service options

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"`

	// The IAM API key that has writer access to the Cloud Object Storage instance. This credential is masked in the
	// response.
	APIKey *string `json:"api_key" validate:"required"`
}

CosEndpoint : Property values for a Cloud Object Storage Endpoint.

type CosWriteStatus added in v0.18.17 

type CosWriteStatus struct {
	// The status such as failed or success.
	Status *string `json:"status,omitempty"`

	// 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"`
}

CosWriteStatus : The status of the write attempt with the provided cos_endpoint parameters.

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"`

	// Indicates whether or not all global events should be forwarded to this region.
	ReceiveGlobalEvents *bool `json:"receive_global_events" validate:"required"`

	// Routing rules that will be evaluated in their order of the array.
	Rules []Rule `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) 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. 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.
	TargetType *string `json:"target_type" validate:"required"`

	// Property values for a Cloud Object Storage Endpoint.
	CosEndpoint *CosEndpoint `json:"cos_endpoint" 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 `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 Endpoints added in v0.19.1 

type Endpoints struct {
	// Activity Tracker API endpoint.
	APIEndpoint *APIEndpoint `json:"api_endpoint" validate:"required"`
}

Endpoints : Activity Tracker endpoints.

type EndpointsRequestAPIEndpoint added in v0.19.1 

type EndpointsRequestAPIEndpoint struct {
	// Indicate whether or not the public endpoint is enabled in an account.
	PublicEnabled *bool `json:"public_enabled,omitempty"`
}

EndpointsRequestAPIEndpoint : Activity Tracker service API endpoint.

type GetEndpointsOptions added in v0.19.1 

type GetEndpointsOptions struct {

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

GetEndpointsOptions : The GetEndpoints options.

func (*GetEndpointsOptions) SetHeaders added in v0.19.1 

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

SetHeaders : Allow user to set Headers

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 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 {

	// 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 PatchEndpointsOptions added in v0.19.1 

type PatchEndpointsOptions struct {
	// Activity Tracker service API endpoint.
	APIEndpoint *EndpointsRequestAPIEndpoint `json:"api_endpoint,omitempty"`

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

PatchEndpointsOptions : The PatchEndpoints options.

func (*PatchEndpointsOptions) SetAPIEndpoint added in v0.19.1 

func (_options *PatchEndpointsOptions) SetAPIEndpoint(apiEndpoint *EndpointsRequestAPIEndpoint) *PatchEndpointsOptions

SetAPIEndpoint : Allow user to set APIEndpoint

func (*PatchEndpointsOptions) SetHeaders added in v0.19.1 

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

SetHeaders : Allow user to set Headers

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"`

	// Indicates whether or not all global events should be forwarded to this region.
	ReceiveGlobalEvents *bool `json:"receive_global_events" validate:"required"`

	// Routing rules that will be evaluated in their order of the array.
	Rules []Rule `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) 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 `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" validate:"required"`

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

	// Property values for a Cloud Object Storage Endpoint.
	CosEndpoint *CosEndpoint `json:"cos_endpoint" 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 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"`

	// Indicates 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"`

	// The timestamp of the route creation time.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp of the route last updated time.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

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 1 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 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"`

	// The encryption key that is used to encrypt events before Activity Tracker services buffer them on storage. This
	// credential is masked in the response.
	EncryptKey *string `json:"encrypt_key,omitempty"`

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

	// The status of the write attempt with the provided cos_endpoint parameters.
	CosWriteStatus *CosWriteStatus `json:"cos_write_status,omitempty"`

	// The timestamp of the target creation time.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp of the target last updated time.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

Target : Property values for a target in the 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.

type ValidateTargetOptions added in v0.18.17 

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

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

SetHeaders : Allow user to set Headers

func (*ValidateTargetOptions) SetID added in v0.18.17 

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

SetID : Allow user to set ID

type Warning added in v0.18.17 

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

	// The warning message.
	Message *string `json:"message,omitempty"`
}

Warning : The warning object.

type WarningReport added in v0.18.17 

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.

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.