proxy

package
v7.2.0 Latest Latest
Warning

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

 Go to latest Published: Sep 2, 2026 License: BSD-3-Clause Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateFunctionRuleOption 

type CreateFunctionRuleOption func(*CreateFunctionRuleOptions)

type CreateFunctionRuleOptions 

type CreateFunctionRuleOptions struct {
	Branch string
	// contains filtered or unexported fields
}

func (CreateFunctionRuleOptions) New 

func (options CreateFunctionRuleOptions) New() *CreateFunctionRuleOptions

type CreateInvalidationOption 

type CreateInvalidationOption func(*CreateInvalidationOptions)

type CreateInvalidationOptions 

type CreateInvalidationOptions struct {
	Reference string
	// contains filtered or unexported fields
}

func (CreateInvalidationOptions) New 

func (options CreateInvalidationOptions) New() *CreateInvalidationOptions

type CreateSiteRuleOption 

type CreateSiteRuleOption func(*CreateSiteRuleOptions)

type CreateSiteRuleOptions 

type CreateSiteRuleOptions struct {
	Branch string
	// contains filtered or unexported fields
}

func (CreateSiteRuleOptions) New 

func (options CreateSiteRuleOptions) New() *CreateSiteRuleOptions

type ListRulesOption 

type ListRulesOption func(*ListRulesOptions)

type ListRulesOptions 

type ListRulesOptions struct {
	Queries []string
	Total   bool
	// contains filtered or unexported fields
}

func (ListRulesOptions) New 

func (options ListRulesOptions) New() *ListRulesOptions

type Proxy 

type Proxy struct {
	// contains filtered or unexported fields
}

Proxy service

func New 

func New(clt client.Client) *Proxy

func (*Proxy) CreateAPIRule 

func (srv *Proxy) CreateAPIRule(Domain string) (*models.ProxyRule, error)

CreateAPIRule create a new proxy rule for serving Appwrite's API on custom domain.

Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.

func (*Proxy) CreateFunctionRule 

func (srv *Proxy) CreateFunctionRule(Domain string, FunctionId string, optionalSetters ...CreateFunctionRuleOption) (*models.ProxyRule, error)

CreateFunctionRule create a new proxy rule for executing Appwrite Function on custom domain.

Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.

func (*Proxy) CreateInvalidation 

func (srv *Proxy) CreateInvalidation(Domain string, Type string, optionalSetters ...CreateInvalidationOption) (*models.ProxyInvalidation, error)

CreateInvalidation create a new CDN cache invalidation for a domain. Executes a hard purge of cached content.

Depending on type, the invalidation purges a single cache tag, a single URL path, or all cached content for the domain.

func (*Proxy) CreateRedirectRule 

func (srv *Proxy) CreateRedirectRule(Domain string, Url string, StatusCode string, ResourceId string, ResourceType string) (*models.ProxyRule, error)

CreateRedirectRule create a new proxy rule for to redirect from custom domain to another domain.

Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.

func (*Proxy) CreateSiteRule 

func (srv *Proxy) CreateSiteRule(Domain string, SiteId string, optionalSetters ...CreateSiteRuleOption) (*models.ProxyRule, error)

CreateSiteRule create a new proxy rule for serving Appwrite Site on custom domain.

Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.

func (*Proxy) DeleteRule 

func (srv *Proxy) DeleteRule(RuleId string) (*interface{}, error)

DeleteRule delete a proxy rule by its unique ID.

func (*Proxy) GetRule 

func (srv *Proxy) GetRule(RuleId string) (*models.ProxyRule, error)

GetRule get a proxy rule by its unique ID.

func (*Proxy) ListRules 

func (srv *Proxy) ListRules(optionalSetters ...ListRulesOption) (*models.ProxyRuleList, error)

ListRules get a list of all the proxy rules. You can use the query params to filter your results.

func (*Proxy) UpdateRuleStatus 

func (srv *Proxy) UpdateRuleStatus(RuleId string) (*models.ProxyRule, error)

UpdateRuleStatus if not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.

func (*Proxy) WithCreateFunctionRuleBranch 

func (srv *Proxy) WithCreateFunctionRuleBranch(v string) CreateFunctionRuleOption

func (*Proxy) WithCreateInvalidationReference 

func (srv *Proxy) WithCreateInvalidationReference(v string) CreateInvalidationOption

func (*Proxy) WithCreateSiteRuleBranch 

func (srv *Proxy) WithCreateSiteRuleBranch(v string) CreateSiteRuleOption

func (*Proxy) WithListRulesQueries 

func (srv *Proxy) WithListRulesQueries(v []string) ListRulesOption

func (*Proxy) WithListRulesTotal 

func (srv *Proxy) WithListRulesTotal(v bool) ListRulesOption

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.