Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateRedirectRule(zoneID, rulesetID string, req CreateRedirectRuleRequest) (*RedirectRule, error)
- func (c *Client) GetRulesetForPhase(zoneID, phase string) (*Ruleset, error)
- func (c *Client) ListRedirectRules(zoneID string) ([]RedirectRule, error)
- func (c *Client) ListZones() ([]Zone, error)
- func (c *Client) UpdateRedirectRule(zoneID, rulesetID, ruleID string, req UpdateRedirectRuleRequest) (*RedirectRule, error)
- type Cloudflare
- func (c *Cloudflare) CleanupWebhook(ctx core.CleanupWebhookContext) error
- func (c *Cloudflare) CompareWebhookConfig(a, b any) (bool, error)
- func (c *Cloudflare) Components() []core.Component
- func (c *Cloudflare) Configuration() []configuration.Field
- func (c *Cloudflare) Description() string
- func (c *Cloudflare) HandleRequest(ctx core.HTTPRequestContext)
- func (c *Cloudflare) Icon() string
- func (c *Cloudflare) InstallationInstructions() string
- func (c *Cloudflare) Label() string
- func (c *Cloudflare) ListResources(resourceType string, ctx core.ListResourcesContext) ([]core.ApplicationResource, error)
- func (c *Cloudflare) Name() string
- func (c *Cloudflare) SetupWebhook(ctx core.SetupWebhookContext) (any, error)
- func (c *Cloudflare) Sync(ctx core.SyncContext) error
- func (c *Cloudflare) Triggers() []core.Trigger
- type Configuration
- type CreateRedirectRuleRequest
- type Metadata
- type RedirectActionData
- type RedirectFromValue
- type RedirectRule
- type RedirectTargetURL
- type Ruleset
- type UpdateRedirectRule
- func (c *UpdateRedirectRule) Actions() []core.Action
- func (c *UpdateRedirectRule) Cancel(ctx core.ExecutionContext) error
- func (c *UpdateRedirectRule) Color() string
- func (c *UpdateRedirectRule) Configuration() []configuration.Field
- func (c *UpdateRedirectRule) Description() string
- func (c *UpdateRedirectRule) Documentation() string
- func (c *UpdateRedirectRule) ExampleOutput() map[string]any
- func (c *UpdateRedirectRule) Execute(ctx core.ExecutionContext) error
- func (c *UpdateRedirectRule) HandleAction(ctx core.ActionContext) error
- func (c *UpdateRedirectRule) HandleWebhook(ctx core.WebhookRequestContext) (int, error)
- func (c *UpdateRedirectRule) Icon() string
- func (c *UpdateRedirectRule) Label() string
- func (c *UpdateRedirectRule) Name() string
- func (c *UpdateRedirectRule) OutputChannels(configuration any) []core.OutputChannel
- func (c *UpdateRedirectRule) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
- func (c *UpdateRedirectRule) Setup(ctx core.SetupContext) error
- type UpdateRedirectRuleMetadata
- type UpdateRedirectRuleRequest
- type UpdateRedirectRuleSpec
- type Zone
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
func NewClient ¶
func NewClient(http core.HTTPContext, ctx core.AppInstallationContext) (*Client, error)
func (*Client) CreateRedirectRule ¶
func (c *Client) CreateRedirectRule(zoneID, rulesetID string, req CreateRedirectRuleRequest) (*RedirectRule, error)
CreateRedirectRule creates a new redirect rule in a zone's ruleset
func (*Client) GetRulesetForPhase ¶
GetRulesetForPhase gets the ruleset ID for a specific phase in a zone
func (*Client) ListRedirectRules ¶
func (c *Client) ListRedirectRules(zoneID string) ([]RedirectRule, error)
ListRedirectRules retrieves all redirect rules for a zone
func (*Client) UpdateRedirectRule ¶
func (c *Client) UpdateRedirectRule(zoneID, rulesetID, ruleID string, req UpdateRedirectRuleRequest) (*RedirectRule, error)
UpdateRedirectRule updates a specific redirect rule in a zone's ruleset
type Cloudflare ¶
type Cloudflare struct{}
func (*Cloudflare) CleanupWebhook ¶
func (c *Cloudflare) CleanupWebhook(ctx core.CleanupWebhookContext) error
func (*Cloudflare) CompareWebhookConfig ¶
func (c *Cloudflare) CompareWebhookConfig(a, b any) (bool, error)
func (*Cloudflare) Components ¶
func (c *Cloudflare) Components() []core.Component
func (*Cloudflare) Configuration ¶
func (c *Cloudflare) Configuration() []configuration.Field
func (*Cloudflare) Description ¶
func (c *Cloudflare) Description() string
func (*Cloudflare) HandleRequest ¶
func (c *Cloudflare) HandleRequest(ctx core.HTTPRequestContext)
func (*Cloudflare) Icon ¶
func (c *Cloudflare) Icon() string
func (*Cloudflare) InstallationInstructions ¶
func (c *Cloudflare) InstallationInstructions() string
func (*Cloudflare) Label ¶
func (c *Cloudflare) Label() string
func (*Cloudflare) ListResources ¶
func (c *Cloudflare) ListResources(resourceType string, ctx core.ListResourcesContext) ([]core.ApplicationResource, error)
func (*Cloudflare) Name ¶
func (c *Cloudflare) Name() string
func (*Cloudflare) SetupWebhook ¶
func (c *Cloudflare) SetupWebhook(ctx core.SetupWebhookContext) (any, error)
func (*Cloudflare) Sync ¶
func (c *Cloudflare) Sync(ctx core.SyncContext) error
func (*Cloudflare) Triggers ¶
func (c *Cloudflare) Triggers() []core.Trigger
type Configuration ¶
type Configuration struct {
APIToken string `json:"apiToken"`
}
type CreateRedirectRuleRequest ¶
type CreateRedirectRuleRequest struct {
Action string `json:"action"`
Expression string `json:"expression"`
Description string `json:"description,omitempty"`
Enabled bool `json:"enabled"`
ActionParam *RedirectActionData `json:"action_parameters,omitempty"`
}
CreateRedirectRuleRequest is the payload for creating a new redirect rule
type RedirectActionData ¶
type RedirectActionData struct {
FromValue *RedirectFromValue `json:"from_value,omitempty"`
}
RedirectActionData contains the redirect configuration
type RedirectFromValue ¶
type RedirectFromValue struct {
StatusCode int `json:"status_code"`
TargetURL *RedirectTargetURL `json:"target_url,omitempty"`
PreserveQueryStr bool `json:"preserve_query_string,omitempty"`
}
RedirectFromValue defines the redirect target
type RedirectRule ¶
type RedirectRule struct {
ID string `json:"id,omitempty"`
Action string `json:"action"`
Expression string `json:"expression"`
Description string `json:"description,omitempty"`
Enabled bool `json:"enabled"`
ActionParam *RedirectActionData `json:"action_parameters,omitempty"`
}
RedirectRule represents a single redirect rule in a ruleset
type RedirectTargetURL ¶
type RedirectTargetURL struct {
Value string `json:"value,omitempty"`
Expression string `json:"expression,omitempty"`
}
RedirectTargetURL defines the target URL for redirect
type Ruleset ¶
type Ruleset struct {
ID string `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
Kind string `json:"kind"`
Phase string `json:"phase"`
Rules []RedirectRule `json:"rules"`
}
Ruleset represents a Cloudflare ruleset
type UpdateRedirectRule ¶
type UpdateRedirectRule struct{}
func (*UpdateRedirectRule) Actions ¶
func (c *UpdateRedirectRule) Actions() []core.Action
func (*UpdateRedirectRule) Cancel ¶
func (c *UpdateRedirectRule) Cancel(ctx core.ExecutionContext) error
func (*UpdateRedirectRule) Color ¶
func (c *UpdateRedirectRule) Color() string
func (*UpdateRedirectRule) Configuration ¶
func (c *UpdateRedirectRule) Configuration() []configuration.Field
func (*UpdateRedirectRule) Description ¶
func (c *UpdateRedirectRule) Description() string
func (*UpdateRedirectRule) Documentation ¶ added in v0.1.6
func (c *UpdateRedirectRule) Documentation() string
func (*UpdateRedirectRule) ExampleOutput ¶
func (c *UpdateRedirectRule) ExampleOutput() map[string]any
func (*UpdateRedirectRule) Execute ¶
func (c *UpdateRedirectRule) Execute(ctx core.ExecutionContext) error
func (*UpdateRedirectRule) HandleAction ¶
func (c *UpdateRedirectRule) HandleAction(ctx core.ActionContext) error
func (*UpdateRedirectRule) HandleWebhook ¶
func (c *UpdateRedirectRule) HandleWebhook(ctx core.WebhookRequestContext) (int, error)
func (*UpdateRedirectRule) Icon ¶
func (c *UpdateRedirectRule) Icon() string
func (*UpdateRedirectRule) Label ¶
func (c *UpdateRedirectRule) Label() string
func (*UpdateRedirectRule) Name ¶
func (c *UpdateRedirectRule) Name() string
func (*UpdateRedirectRule) OutputChannels ¶
func (c *UpdateRedirectRule) OutputChannels(configuration any) []core.OutputChannel
func (*UpdateRedirectRule) ProcessQueueItem ¶
func (c *UpdateRedirectRule) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
func (*UpdateRedirectRule) Setup ¶
func (c *UpdateRedirectRule) Setup(ctx core.SetupContext) error
type UpdateRedirectRuleMetadata ¶
type UpdateRedirectRuleMetadata struct {
Zone *Zone `json:"zone"`
}
type UpdateRedirectRuleRequest ¶
type UpdateRedirectRuleRequest struct {
Action string `json:"action"`
Expression string `json:"expression"`
Description string `json:"description,omitempty"`
Enabled bool `json:"enabled"`
ActionParam *RedirectActionData `json:"action_parameters,omitempty"`
}
UpdateRedirectRuleRequest is the payload for updating a redirect rule
type UpdateRedirectRuleSpec ¶
type UpdateRedirectRuleSpec struct {
Zone string `json:"zone"`
RuleID string `json:"ruleId"`
Description string `json:"description"`
MatchType string `json:"matchType"`
SourceURLPattern string `json:"sourceUrlPattern"`
Expression string `json:"expression"`
TargetURL string `json:"targetUrl"`
StatusCode string `json:"statusCode"`
PreserveQueryStr bool `json:"preserveQueryString"`
Enabled bool `json:"enabled"`
}