edgefunctionsapiv1

package
v0.46.1 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 10 Imported by: 5

Documentation

Overview

Package edgefunctionsapiv1 : Operations and models for the EdgeFunctionsApiV1 service

Index

Constants

View Source 
const DefaultServiceName = "edge_functions_api"

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

View Source 
const DefaultServiceURL = "https://api.cis.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion added in v0.12.1 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalCreateEdgeFunctionsTriggerResp 

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

UnmarshalCreateEdgeFunctionsTriggerResp unmarshals an instance of CreateEdgeFunctionsTriggerResp from the specified map of raw messages.

func UnmarshalDeleteEdgeFunctionsActionResp 

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

UnmarshalDeleteEdgeFunctionsActionResp unmarshals an instance of DeleteEdgeFunctionsActionResp from the specified map of raw messages.

func UnmarshalEdgeFunctionsActionID 

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

UnmarshalEdgeFunctionsActionID unmarshals an instance of EdgeFunctionsActionID from the specified map of raw messages.

func UnmarshalEdgeFunctionsActionResp 

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

UnmarshalEdgeFunctionsActionResp unmarshals an instance of EdgeFunctionsActionResp from the specified map of raw messages.

func UnmarshalEdgeFunctionsTriggerID 

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

UnmarshalEdgeFunctionsTriggerID unmarshals an instance of EdgeFunctionsTriggerID from the specified map of raw messages.

func UnmarshalEdgeFunctionsTriggerResp 

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

UnmarshalEdgeFunctionsTriggerResp unmarshals an instance of EdgeFunctionsTriggerResp from the specified map of raw messages.

func UnmarshalGetEdgeFunctionsActionResp 

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

UnmarshalGetEdgeFunctionsActionResp unmarshals an instance of GetEdgeFunctionsActionResp from the specified map of raw messages.

func UnmarshalGetEdgeFunctionsTriggerResp 

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

UnmarshalGetEdgeFunctionsTriggerResp unmarshals an instance of GetEdgeFunctionsTriggerResp from the specified map of raw messages.

func UnmarshalListEdgeFunctionsActionsResp 

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

UnmarshalListEdgeFunctionsActionsResp unmarshals an instance of ListEdgeFunctionsActionsResp from the specified map of raw messages.

func UnmarshalListEdgeFunctionsTriggersResp 

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

UnmarshalListEdgeFunctionsTriggersResp unmarshals an instance of ListEdgeFunctionsTriggersResp from the specified map of raw messages.

Types

type CreateEdgeFunctionsTriggerOptions 

type CreateEdgeFunctionsTriggerOptions struct {
	// a string pattern.
	Pattern *string `json:"pattern,omitempty"`

	// Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.
	Script *string `json:"script,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

CreateEdgeFunctionsTriggerOptions : The CreateEdgeFunctionsTrigger options.

func (*CreateEdgeFunctionsTriggerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateEdgeFunctionsTriggerOptions) SetPattern 

func (options *CreateEdgeFunctionsTriggerOptions) SetPattern(pattern string) *CreateEdgeFunctionsTriggerOptions

SetPattern : Allow user to set Pattern

func (*CreateEdgeFunctionsTriggerOptions) SetScript 

func (options *CreateEdgeFunctionsTriggerOptions) SetScript(script string) *CreateEdgeFunctionsTriggerOptions

SetScript : Allow user to set Script

func (*CreateEdgeFunctionsTriggerOptions) SetXCorrelationID 

func (options *CreateEdgeFunctionsTriggerOptions) SetXCorrelationID(xCorrelationID string) *CreateEdgeFunctionsTriggerOptions

SetXCorrelationID : Allow user to set XCorrelationID

type CreateEdgeFunctionsTriggerResp 

type CreateEdgeFunctionsTriggerResp struct {
	// edge function trigger id.
	Result *EdgeFunctionsTriggerID `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	// An array with errors.
	Errors []string `json:"errors,omitempty"`

	// An array with messages.
	Messages []string `json:"messages,omitempty"`
}

CreateEdgeFunctionsTriggerResp : create an edge funtions trigger response.

type DeleteEdgeFunctionsActionOptions 

type DeleteEdgeFunctionsActionOptions struct {
	// the edge function action name.
	ScriptName *string `json:"script_name" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

DeleteEdgeFunctionsActionOptions : The DeleteEdgeFunctionsAction options.

func (*DeleteEdgeFunctionsActionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteEdgeFunctionsActionOptions) SetScriptName 

func (options *DeleteEdgeFunctionsActionOptions) SetScriptName(scriptName string) *DeleteEdgeFunctionsActionOptions

SetScriptName : Allow user to set ScriptName

func (*DeleteEdgeFunctionsActionOptions) SetXCorrelationID 

func (options *DeleteEdgeFunctionsActionOptions) SetXCorrelationID(xCorrelationID string) *DeleteEdgeFunctionsActionOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DeleteEdgeFunctionsActionResp 

type DeleteEdgeFunctionsActionResp struct {
	// edge function action id.
	Result *EdgeFunctionsActionID `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	// An array with errors.
	Errors []string `json:"errors,omitempty"`

	// An array with messages.
	Messages []string `json:"messages,omitempty"`
}

DeleteEdgeFunctionsActionResp : create an edge funtions trigger response.

type DeleteEdgeFunctionsTriggerOptions 

type DeleteEdgeFunctionsTriggerOptions struct {
	// trigger identifier.
	RouteID *string `json:"route_id" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

DeleteEdgeFunctionsTriggerOptions : The DeleteEdgeFunctionsTrigger options.

func (*DeleteEdgeFunctionsTriggerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteEdgeFunctionsTriggerOptions) SetRouteID 

func (options *DeleteEdgeFunctionsTriggerOptions) SetRouteID(routeID string) *DeleteEdgeFunctionsTriggerOptions

SetRouteID : Allow user to set RouteID

func (*DeleteEdgeFunctionsTriggerOptions) SetXCorrelationID 

func (options *DeleteEdgeFunctionsTriggerOptions) SetXCorrelationID(xCorrelationID string) *DeleteEdgeFunctionsTriggerOptions

SetXCorrelationID : Allow user to set XCorrelationID

type EdgeFunctionsActionID 

type EdgeFunctionsActionID struct {
	// edge functions action identifier tag.
	ID *string `json:"id,omitempty"`
}

EdgeFunctionsActionID : edge function action id.

type EdgeFunctionsActionResp 

type EdgeFunctionsActionResp struct {
	// Raw script content, as a string.
	Script *string `json:"script,omitempty"`

	// Hashed script content, can be used in a If-None-Match header when updating.
	Etag *string `json:"etag,omitempty"`

	// handlers.
	Handlers []string `json:"handlers,omitempty"`

	// The time when the script was last modified.
	ModifiedOn *strfmt.DateTime `json:"modified_on,omitempty"`

	// The time when the script was last created.
	CreatedOn *strfmt.DateTime `json:"created_on,omitempty"`

	// An array with items in the list response.
	Routes []EdgeFunctionsTriggerResp `json:"routes,omitempty"`
}

EdgeFunctionsActionResp : edge function script.

type EdgeFunctionsApiV1 

type EdgeFunctionsApiV1 struct {
	Service *core.BaseService

	// cloud resource name.
	Crn *string

	// zone identifier.
	ZoneIdentifier *string
}

EdgeFunctionsApiV1 : Edge Functions

Version: 1.0.0

func NewEdgeFunctionsApiV1 

func NewEdgeFunctionsApiV1(options *EdgeFunctionsApiV1Options) (service *EdgeFunctionsApiV1, err error)

NewEdgeFunctionsApiV1 : constructs an instance of EdgeFunctionsApiV1 with passed in options.

func NewEdgeFunctionsApiV1UsingExternalConfig 

func NewEdgeFunctionsApiV1UsingExternalConfig(options *EdgeFunctionsApiV1Options) (edgeFunctionsApi *EdgeFunctionsApiV1, err error)

NewEdgeFunctionsApiV1UsingExternalConfig : constructs an instance of EdgeFunctionsApiV1 with passed in options and external configuration.

func (*EdgeFunctionsApiV1) Clone added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) Clone() *EdgeFunctionsApiV1

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

func (*EdgeFunctionsApiV1) CreateEdgeFunctionsTrigger 

func (edgeFunctionsApi *EdgeFunctionsApiV1) CreateEdgeFunctionsTrigger(createEdgeFunctionsTriggerOptions *CreateEdgeFunctionsTriggerOptions) (result *CreateEdgeFunctionsTriggerResp, response *core.DetailedResponse, err error)

CreateEdgeFunctionsTrigger : Create an edge functions trigger on a given zone Create an edge functions trigger on a given zone.

func (*EdgeFunctionsApiV1) CreateEdgeFunctionsTriggerWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) CreateEdgeFunctionsTriggerWithContext(ctx context.Context, createEdgeFunctionsTriggerOptions *CreateEdgeFunctionsTriggerOptions) (result *CreateEdgeFunctionsTriggerResp, response *core.DetailedResponse, err error)

CreateEdgeFunctionsTriggerWithContext is an alternate form of the CreateEdgeFunctionsTrigger method which supports a Context parameter

func (*EdgeFunctionsApiV1) DeleteEdgeFunctionsAction 

func (edgeFunctionsApi *EdgeFunctionsApiV1) DeleteEdgeFunctionsAction(deleteEdgeFunctionsActionOptions *DeleteEdgeFunctionsActionOptions) (result *DeleteEdgeFunctionsActionResp, response *core.DetailedResponse, err error)

DeleteEdgeFunctionsAction : Delete a edge functions action for a given instance Delete an edge functions action for a given instance.

func (*EdgeFunctionsApiV1) DeleteEdgeFunctionsActionWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) DeleteEdgeFunctionsActionWithContext(ctx context.Context, deleteEdgeFunctionsActionOptions *DeleteEdgeFunctionsActionOptions) (result *DeleteEdgeFunctionsActionResp, response *core.DetailedResponse, err error)

DeleteEdgeFunctionsActionWithContext is an alternate form of the DeleteEdgeFunctionsAction method which supports a Context parameter

func (*EdgeFunctionsApiV1) DeleteEdgeFunctionsTrigger 

func (edgeFunctionsApi *EdgeFunctionsApiV1) DeleteEdgeFunctionsTrigger(deleteEdgeFunctionsTriggerOptions *DeleteEdgeFunctionsTriggerOptions) (result *CreateEdgeFunctionsTriggerResp, response *core.DetailedResponse, err error)

DeleteEdgeFunctionsTrigger : Delete an edge functions trigger on a given zone Delete an edge functions trigger on a given zone.

func (*EdgeFunctionsApiV1) DeleteEdgeFunctionsTriggerWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) DeleteEdgeFunctionsTriggerWithContext(ctx context.Context, deleteEdgeFunctionsTriggerOptions *DeleteEdgeFunctionsTriggerOptions) (result *CreateEdgeFunctionsTriggerResp, response *core.DetailedResponse, err error)

DeleteEdgeFunctionsTriggerWithContext is an alternate form of the DeleteEdgeFunctionsTrigger method which supports a Context parameter

func (*EdgeFunctionsApiV1) DisableRetries added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) DisableRetries()

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

func (*EdgeFunctionsApiV1) EnableRetries added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) 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 (*EdgeFunctionsApiV1) GetEdgeFunctionsAction 

func (edgeFunctionsApi *EdgeFunctionsApiV1) GetEdgeFunctionsAction(getEdgeFunctionsActionOptions *GetEdgeFunctionsActionOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetEdgeFunctionsAction : Download a edge functions action for a given instance Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.

func (*EdgeFunctionsApiV1) GetEdgeFunctionsActionWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) GetEdgeFunctionsActionWithContext(ctx context.Context, getEdgeFunctionsActionOptions *GetEdgeFunctionsActionOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetEdgeFunctionsActionWithContext is an alternate form of the GetEdgeFunctionsAction method which supports a Context parameter

func (*EdgeFunctionsApiV1) GetEdgeFunctionsTrigger 

func (edgeFunctionsApi *EdgeFunctionsApiV1) GetEdgeFunctionsTrigger(getEdgeFunctionsTriggerOptions *GetEdgeFunctionsTriggerOptions) (result *GetEdgeFunctionsTriggerResp, response *core.DetailedResponse, err error)

GetEdgeFunctionsTrigger : Get an edge functions trigger on a given zone Get an edge functions trigger on a given zone.

func (*EdgeFunctionsApiV1) GetEdgeFunctionsTriggerWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) GetEdgeFunctionsTriggerWithContext(ctx context.Context, getEdgeFunctionsTriggerOptions *GetEdgeFunctionsTriggerOptions) (result *GetEdgeFunctionsTriggerResp, response *core.DetailedResponse, err error)

GetEdgeFunctionsTriggerWithContext is an alternate form of the GetEdgeFunctionsTrigger method which supports a Context parameter

func (*EdgeFunctionsApiV1) GetEnableGzipCompression added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*EdgeFunctionsApiV1) GetServiceURL added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*EdgeFunctionsApiV1) ListEdgeFunctionsActions 

func (edgeFunctionsApi *EdgeFunctionsApiV1) ListEdgeFunctionsActions(listEdgeFunctionsActionsOptions *ListEdgeFunctionsActionsOptions) (result *ListEdgeFunctionsActionsResp, response *core.DetailedResponse, err error)

ListEdgeFunctionsActions : Get all edge functions scripts for a given instance Get all edge functions scripts for a given instance.

func (*EdgeFunctionsApiV1) ListEdgeFunctionsActionsWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) ListEdgeFunctionsActionsWithContext(ctx context.Context, listEdgeFunctionsActionsOptions *ListEdgeFunctionsActionsOptions) (result *ListEdgeFunctionsActionsResp, response *core.DetailedResponse, err error)

ListEdgeFunctionsActionsWithContext is an alternate form of the ListEdgeFunctionsActions method which supports a Context parameter

func (*EdgeFunctionsApiV1) ListEdgeFunctionsTriggers 

func (edgeFunctionsApi *EdgeFunctionsApiV1) ListEdgeFunctionsTriggers(listEdgeFunctionsTriggersOptions *ListEdgeFunctionsTriggersOptions) (result *ListEdgeFunctionsTriggersResp, response *core.DetailedResponse, err error)

ListEdgeFunctionsTriggers : List all edge functions triggers on a given zone List all edge functions triggers on a given zone.

func (*EdgeFunctionsApiV1) ListEdgeFunctionsTriggersWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) ListEdgeFunctionsTriggersWithContext(ctx context.Context, listEdgeFunctionsTriggersOptions *ListEdgeFunctionsTriggersOptions) (result *ListEdgeFunctionsTriggersResp, response *core.DetailedResponse, err error)

ListEdgeFunctionsTriggersWithContext is an alternate form of the ListEdgeFunctionsTriggers method which supports a Context parameter

func (*EdgeFunctionsApiV1) NewCreateEdgeFunctionsTriggerOptions 

func (*EdgeFunctionsApiV1) NewCreateEdgeFunctionsTriggerOptions() *CreateEdgeFunctionsTriggerOptions

NewCreateEdgeFunctionsTriggerOptions : Instantiate CreateEdgeFunctionsTriggerOptions

func (*EdgeFunctionsApiV1) NewDeleteEdgeFunctionsActionOptions 

func (*EdgeFunctionsApiV1) NewDeleteEdgeFunctionsActionOptions(scriptName string) *DeleteEdgeFunctionsActionOptions

NewDeleteEdgeFunctionsActionOptions : Instantiate DeleteEdgeFunctionsActionOptions

func (*EdgeFunctionsApiV1) NewDeleteEdgeFunctionsTriggerOptions 

func (*EdgeFunctionsApiV1) NewDeleteEdgeFunctionsTriggerOptions(routeID string) *DeleteEdgeFunctionsTriggerOptions

NewDeleteEdgeFunctionsTriggerOptions : Instantiate DeleteEdgeFunctionsTriggerOptions

func (*EdgeFunctionsApiV1) NewGetEdgeFunctionsActionOptions 

func (*EdgeFunctionsApiV1) NewGetEdgeFunctionsActionOptions(scriptName string) *GetEdgeFunctionsActionOptions

NewGetEdgeFunctionsActionOptions : Instantiate GetEdgeFunctionsActionOptions

func (*EdgeFunctionsApiV1) NewGetEdgeFunctionsTriggerOptions 

func (*EdgeFunctionsApiV1) NewGetEdgeFunctionsTriggerOptions(routeID string) *GetEdgeFunctionsTriggerOptions

NewGetEdgeFunctionsTriggerOptions : Instantiate GetEdgeFunctionsTriggerOptions

func (*EdgeFunctionsApiV1) NewListEdgeFunctionsActionsOptions 

func (*EdgeFunctionsApiV1) NewListEdgeFunctionsActionsOptions() *ListEdgeFunctionsActionsOptions

NewListEdgeFunctionsActionsOptions : Instantiate ListEdgeFunctionsActionsOptions

func (*EdgeFunctionsApiV1) NewListEdgeFunctionsTriggersOptions 

func (*EdgeFunctionsApiV1) NewListEdgeFunctionsTriggersOptions() *ListEdgeFunctionsTriggersOptions

NewListEdgeFunctionsTriggersOptions : Instantiate ListEdgeFunctionsTriggersOptions

func (*EdgeFunctionsApiV1) NewUpdateEdgeFunctionsActionOptions 

func (*EdgeFunctionsApiV1) NewUpdateEdgeFunctionsActionOptions(scriptName string) *UpdateEdgeFunctionsActionOptions

NewUpdateEdgeFunctionsActionOptions : Instantiate UpdateEdgeFunctionsActionOptions

func (*EdgeFunctionsApiV1) NewUpdateEdgeFunctionsTriggerOptions 

func (*EdgeFunctionsApiV1) NewUpdateEdgeFunctionsTriggerOptions(routeID string) *UpdateEdgeFunctionsTriggerOptions

NewUpdateEdgeFunctionsTriggerOptions : Instantiate UpdateEdgeFunctionsTriggerOptions

func (*EdgeFunctionsApiV1) SetDefaultHeaders added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*EdgeFunctionsApiV1) SetEnableGzipCompression added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*EdgeFunctionsApiV1) SetServiceURL 

func (edgeFunctionsApi *EdgeFunctionsApiV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*EdgeFunctionsApiV1) UpdateEdgeFunctionsAction 

func (edgeFunctionsApi *EdgeFunctionsApiV1) UpdateEdgeFunctionsAction(updateEdgeFunctionsActionOptions *UpdateEdgeFunctionsActionOptions) (result *GetEdgeFunctionsActionResp, response *core.DetailedResponse, err error)

UpdateEdgeFunctionsAction : Upload or replace an edge functions action for a given instance Upload or replace an exitsing edge functions action for a given instance.

func (*EdgeFunctionsApiV1) UpdateEdgeFunctionsActionWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) UpdateEdgeFunctionsActionWithContext(ctx context.Context, updateEdgeFunctionsActionOptions *UpdateEdgeFunctionsActionOptions) (result *GetEdgeFunctionsActionResp, response *core.DetailedResponse, err error)

UpdateEdgeFunctionsActionWithContext is an alternate form of the UpdateEdgeFunctionsAction method which supports a Context parameter

func (*EdgeFunctionsApiV1) UpdateEdgeFunctionsTrigger 

func (edgeFunctionsApi *EdgeFunctionsApiV1) UpdateEdgeFunctionsTrigger(updateEdgeFunctionsTriggerOptions *UpdateEdgeFunctionsTriggerOptions) (result *GetEdgeFunctionsTriggerResp, response *core.DetailedResponse, err error)

UpdateEdgeFunctionsTrigger : Update an edge functions trigger on a given zone Update an edge functions trigger on a given zone.

func (*EdgeFunctionsApiV1) UpdateEdgeFunctionsTriggerWithContext added in v0.12.1 

func (edgeFunctionsApi *EdgeFunctionsApiV1) UpdateEdgeFunctionsTriggerWithContext(ctx context.Context, updateEdgeFunctionsTriggerOptions *UpdateEdgeFunctionsTriggerOptions) (result *GetEdgeFunctionsTriggerResp, response *core.DetailedResponse, err error)

UpdateEdgeFunctionsTriggerWithContext is an alternate form of the UpdateEdgeFunctionsTrigger method which supports a Context parameter

type EdgeFunctionsApiV1Options 

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

	// cloud resource name.
	Crn *string `validate:"required"`

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

EdgeFunctionsApiV1Options : Service options

type EdgeFunctionsTriggerID 

type EdgeFunctionsTriggerID struct {
	// edge functions trigger identifier tag.
	ID *string `json:"id,omitempty"`
}

EdgeFunctionsTriggerID : edge function trigger id.

type EdgeFunctionsTriggerResp 

type EdgeFunctionsTriggerResp struct {
	// edge functions trigger identifier tag.
	ID *string `json:"id,omitempty"`

	// a string pattern.
	Pattern *string `json:"pattern,omitempty"`

	// Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.
	Script *string `json:"script,omitempty"`

	// request limit fail open or not.
	RequestLimitFailOpen *bool `json:"request_limit_fail_open,omitempty"`
}

EdgeFunctionsTriggerResp : edge function trigger id.

type GetEdgeFunctionsActionOptions 

type GetEdgeFunctionsActionOptions struct {
	// the edge function action name.
	ScriptName *string `json:"script_name" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

GetEdgeFunctionsActionOptions : The GetEdgeFunctionsAction options.

func (*GetEdgeFunctionsActionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetEdgeFunctionsActionOptions) SetScriptName 

func (options *GetEdgeFunctionsActionOptions) SetScriptName(scriptName string) *GetEdgeFunctionsActionOptions

SetScriptName : Allow user to set ScriptName

func (*GetEdgeFunctionsActionOptions) SetXCorrelationID 

func (options *GetEdgeFunctionsActionOptions) SetXCorrelationID(xCorrelationID string) *GetEdgeFunctionsActionOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetEdgeFunctionsActionResp 

type GetEdgeFunctionsActionResp struct {
	// edge function script.
	Result *EdgeFunctionsActionResp `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	// An array with errors.
	Errors []string `json:"errors,omitempty"`

	// An array with messages.
	Messages []string `json:"messages,omitempty"`
}

GetEdgeFunctionsActionResp : edge funtions action response.

type GetEdgeFunctionsTriggerOptions 

type GetEdgeFunctionsTriggerOptions struct {
	// trigger identifier.
	RouteID *string `json:"route_id" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

GetEdgeFunctionsTriggerOptions : The GetEdgeFunctionsTrigger options.

func (*GetEdgeFunctionsTriggerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetEdgeFunctionsTriggerOptions) SetRouteID 

func (options *GetEdgeFunctionsTriggerOptions) SetRouteID(routeID string) *GetEdgeFunctionsTriggerOptions

SetRouteID : Allow user to set RouteID

func (*GetEdgeFunctionsTriggerOptions) SetXCorrelationID 

func (options *GetEdgeFunctionsTriggerOptions) SetXCorrelationID(xCorrelationID string) *GetEdgeFunctionsTriggerOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetEdgeFunctionsTriggerResp 

type GetEdgeFunctionsTriggerResp struct {
	// edge function trigger id.
	Result *EdgeFunctionsTriggerResp `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	// An array with errors.
	Errors []string `json:"errors,omitempty"`

	// An array with messages.
	Messages []string `json:"messages,omitempty"`
}

GetEdgeFunctionsTriggerResp : edge funtions trigger response.

type ListEdgeFunctionsActionsOptions 

type ListEdgeFunctionsActionsOptions struct {
	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

ListEdgeFunctionsActionsOptions : The ListEdgeFunctionsActions options.

func (*ListEdgeFunctionsActionsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListEdgeFunctionsActionsOptions) SetXCorrelationID 

func (options *ListEdgeFunctionsActionsOptions) SetXCorrelationID(xCorrelationID string) *ListEdgeFunctionsActionsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ListEdgeFunctionsActionsResp 

type ListEdgeFunctionsActionsResp struct {
	// An array with items in the list response.
	Result []EdgeFunctionsActionResp `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	// An array with errors.
	Errors []string `json:"errors,omitempty"`

	// An array with messages.
	Messages []string `json:"messages,omitempty"`
}

ListEdgeFunctionsActionsResp : edge funtions actions response.

type ListEdgeFunctionsTriggersOptions 

type ListEdgeFunctionsTriggersOptions struct {
	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

ListEdgeFunctionsTriggersOptions : The ListEdgeFunctionsTriggers options.

func (*ListEdgeFunctionsTriggersOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListEdgeFunctionsTriggersOptions) SetXCorrelationID 

func (options *ListEdgeFunctionsTriggersOptions) SetXCorrelationID(xCorrelationID string) *ListEdgeFunctionsTriggersOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ListEdgeFunctionsTriggersResp 

type ListEdgeFunctionsTriggersResp struct {
	// An array with items in the list response.
	Result []EdgeFunctionsTriggerResp `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	// An array with errors.
	Errors []string `json:"errors,omitempty"`

	// An array with messages.
	Messages []string `json:"messages,omitempty"`
}

ListEdgeFunctionsTriggersResp : edge funtions triggers response.

type UpdateEdgeFunctionsActionOptions 

type UpdateEdgeFunctionsActionOptions struct {
	// the edge function action name.
	ScriptName *string `json:"script_name" validate:"required,ne="`

	// upload or replace an edge functions action.
	EdgeFunctionsAction io.ReadCloser `json:"edge_functions_action,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

UpdateEdgeFunctionsActionOptions : The UpdateEdgeFunctionsAction options.

func (*UpdateEdgeFunctionsActionOptions) SetEdgeFunctionsAction 

func (options *UpdateEdgeFunctionsActionOptions) SetEdgeFunctionsAction(edgeFunctionsAction io.ReadCloser) *UpdateEdgeFunctionsActionOptions

SetEdgeFunctionsAction : Allow user to set EdgeFunctionsAction

func (*UpdateEdgeFunctionsActionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateEdgeFunctionsActionOptions) SetScriptName 

func (options *UpdateEdgeFunctionsActionOptions) SetScriptName(scriptName string) *UpdateEdgeFunctionsActionOptions

SetScriptName : Allow user to set ScriptName

func (*UpdateEdgeFunctionsActionOptions) SetXCorrelationID 

func (options *UpdateEdgeFunctionsActionOptions) SetXCorrelationID(xCorrelationID string) *UpdateEdgeFunctionsActionOptions

SetXCorrelationID : Allow user to set XCorrelationID

type UpdateEdgeFunctionsTriggerOptions 

type UpdateEdgeFunctionsTriggerOptions struct {
	// trigger identifier.
	RouteID *string `json:"route_id" validate:"required,ne="`

	// a string pattern.
	Pattern *string `json:"pattern,omitempty"`

	// Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.
	Script *string `json:"script,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

UpdateEdgeFunctionsTriggerOptions : The UpdateEdgeFunctionsTrigger options.

func (*UpdateEdgeFunctionsTriggerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateEdgeFunctionsTriggerOptions) SetPattern 

func (options *UpdateEdgeFunctionsTriggerOptions) SetPattern(pattern string) *UpdateEdgeFunctionsTriggerOptions

SetPattern : Allow user to set Pattern

func (*UpdateEdgeFunctionsTriggerOptions) SetRouteID 

func (options *UpdateEdgeFunctionsTriggerOptions) SetRouteID(routeID string) *UpdateEdgeFunctionsTriggerOptions

SetRouteID : Allow user to set RouteID

func (*UpdateEdgeFunctionsTriggerOptions) SetScript 

func (options *UpdateEdgeFunctionsTriggerOptions) SetScript(script string) *UpdateEdgeFunctionsTriggerOptions

SetScript : Allow user to set Script

func (*UpdateEdgeFunctionsTriggerOptions) SetXCorrelationID 

func (options *UpdateEdgeFunctionsTriggerOptions) SetXCorrelationID(xCorrelationID string) *UpdateEdgeFunctionsTriggerOptions

SetXCorrelationID : Allow user to set XCorrelationID

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.