rest_model_zrok

package
v1.0.0-rc0 Latest Latest
Warning

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

 Go to latest Published: Feb 6, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// ShareRequestBackendModeProxy captures enum value "proxy"
	ShareRequestBackendModeProxy string = "proxy"

	// ShareRequestBackendModeWeb captures enum value "web"
	ShareRequestBackendModeWeb string = "web"

	// ShareRequestBackendModeTCPTunnel captures enum value "tcpTunnel"
	ShareRequestBackendModeTCPTunnel string = "tcpTunnel"

	// ShareRequestBackendModeUDPTunnel captures enum value "udpTunnel"
	ShareRequestBackendModeUDPTunnel string = "udpTunnel"

	// ShareRequestBackendModeCaddy captures enum value "caddy"
	ShareRequestBackendModeCaddy string = "caddy"

	// ShareRequestBackendModeDrive captures enum value "drive"
	ShareRequestBackendModeDrive string = "drive"

	// ShareRequestBackendModeSocks captures enum value "socks"
	ShareRequestBackendModeSocks string = "socks"

	// ShareRequestBackendModeVpn captures enum value "vpn"
	ShareRequestBackendModeVpn string = "vpn"
)
View Source 
const (

	// ShareRequestOauthProviderGithub captures enum value "github"
	ShareRequestOauthProviderGithub string = "github"

	// ShareRequestOauthProviderGoogle captures enum value "google"
	ShareRequestOauthProviderGoogle string = "google"
)
View Source 
const (

	// ShareRequestPermissionModeOpen captures enum value "open"
	ShareRequestPermissionModeOpen string = "open"

	// ShareRequestPermissionModeClosed captures enum value "closed"
	ShareRequestPermissionModeClosed string = "closed"
)
View Source 
const (

	// ShareRequestShareModePublic captures enum value "public"
	ShareRequestShareModePublic string = "public"

	// ShareRequestShareModePrivate captures enum value "private"
	ShareRequestShareModePrivate string = "private"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthUser 

type AuthUser struct {

	// password
	Password string `json:"password,omitempty"`

	// username
	Username string `json:"username,omitempty"`
}

AuthUser auth user

swagger:model authUser

func (*AuthUser) ContextValidate 

func (m *AuthUser) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this auth user based on context it is used

func (*AuthUser) MarshalBinary 

func (m *AuthUser) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuthUser) UnmarshalBinary 

func (m *AuthUser) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuthUser) Validate 

func (m *AuthUser) Validate(formats strfmt.Registry) error

Validate validates this auth user

type Configuration 

type Configuration struct {

	// invite token contact
	InviteTokenContact string `json:"inviteTokenContact,omitempty"`

	// invites open
	InvitesOpen bool `json:"invitesOpen,omitempty"`

	// requires invite token
	RequiresInviteToken bool `json:"requiresInviteToken,omitempty"`

	// tou link
	TouLink string `json:"touLink,omitempty"`

	// version
	Version string `json:"version,omitempty"`
}

Configuration configuration

swagger:model configuration

func (*Configuration) ContextValidate 

func (m *Configuration) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this configuration based on context it is used

func (*Configuration) MarshalBinary 

func (m *Configuration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Configuration) UnmarshalBinary 

func (m *Configuration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Configuration) Validate 

func (m *Configuration) Validate(formats strfmt.Registry) error

Validate validates this configuration

type Environment 

type Environment struct {

	// activity
	Activity SparkData `json:"activity,omitempty"`

	// address
	Address string `json:"address,omitempty"`

	// created at
	CreatedAt int64 `json:"createdAt,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// host
	Host string `json:"host,omitempty"`

	// limited
	Limited bool `json:"limited,omitempty"`

	// updated at
	UpdatedAt int64 `json:"updatedAt,omitempty"`

	// z Id
	ZID string `json:"zId,omitempty"`
}

Environment environment

swagger:model environment

func (*Environment) ContextValidate 

func (m *Environment) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this environment based on the context it is used

func (*Environment) MarshalBinary 

func (m *Environment) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Environment) UnmarshalBinary 

func (m *Environment) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Environment) Validate 

func (m *Environment) Validate(formats strfmt.Registry) error

Validate validates this environment

type EnvironmentAndResources added in v0.4.0 

type EnvironmentAndResources struct {

	// environment
	Environment *Environment `json:"environment,omitempty"`

	// frontends
	Frontends Frontends `json:"frontends,omitempty"`

	// shares
	Shares Shares `json:"shares,omitempty"`
}

EnvironmentAndResources environment and resources

swagger:model environmentAndResources

func (*EnvironmentAndResources) ContextValidate added in v0.4.0 

func (m *EnvironmentAndResources) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this environment and resources based on the context it is used

func (*EnvironmentAndResources) MarshalBinary added in v0.4.0 

func (m *EnvironmentAndResources) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EnvironmentAndResources) UnmarshalBinary added in v0.4.0 

func (m *EnvironmentAndResources) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EnvironmentAndResources) Validate added in v0.4.0 

func (m *EnvironmentAndResources) Validate(formats strfmt.Registry) error

Validate validates this environment and resources

type Environments 

type Environments []*Environment

Environments environments

swagger:model environments

func (Environments) ContextValidate 

func (m Environments) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this environments based on the context it is used

func (Environments) Validate 

func (m Environments) Validate(formats strfmt.Registry) error

Validate validates this environments

type ErrorMessage 

type ErrorMessage string

ErrorMessage error message

swagger:model errorMessage

func (ErrorMessage) ContextValidate 

func (m ErrorMessage) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error message based on context it is used

func (ErrorMessage) Validate 

func (m ErrorMessage) Validate(formats strfmt.Registry) error

Validate validates this error message

type Frontend added in v0.4.0 

type Frontend struct {

	// backend mode
	BackendMode string `json:"backendMode,omitempty"`

	// bind address
	BindAddress string `json:"bindAddress,omitempty"`

	// created at
	CreatedAt int64 `json:"createdAt,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// frontend token
	FrontendToken string `json:"frontendToken,omitempty"`

	// id
	ID int64 `json:"id,omitempty"`

	// share token
	ShareToken string `json:"shareToken,omitempty"`

	// updated at
	UpdatedAt int64 `json:"updatedAt,omitempty"`

	// z Id
	ZID string `json:"zId,omitempty"`
}

Frontend frontend

swagger:model frontend

func (*Frontend) ContextValidate added in v0.4.0 

func (m *Frontend) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this frontend based on context it is used

func (*Frontend) MarshalBinary added in v0.4.0 

func (m *Frontend) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Frontend) UnmarshalBinary added in v0.4.0 

func (m *Frontend) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Frontend) Validate added in v0.4.0 

func (m *Frontend) Validate(formats strfmt.Registry) error

Validate validates this frontend

type Frontends added in v0.4.0 

type Frontends []*Frontend

Frontends frontends

swagger:model frontends

func (Frontends) ContextValidate added in v0.4.0 

func (m Frontends) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this frontends based on the context it is used

func (Frontends) Validate added in v0.4.0 

func (m Frontends) Validate(formats strfmt.Registry) error

Validate validates this frontends

type Metrics added in v0.4.0 

type Metrics struct {

	// id
	ID string `json:"id,omitempty"`

	// period
	Period float64 `json:"period,omitempty"`

	// samples
	Samples []*MetricsSample `json:"samples"`

	// scope
	Scope string `json:"scope,omitempty"`
}

Metrics metrics

swagger:model metrics

func (*Metrics) ContextValidate added in v0.4.0 

func (m *Metrics) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this metrics based on the context it is used

func (*Metrics) MarshalBinary added in v0.4.0 

func (m *Metrics) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Metrics) UnmarshalBinary added in v0.4.0 

func (m *Metrics) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Metrics) Validate added in v0.4.0 

func (m *Metrics) Validate(formats strfmt.Registry) error

Validate validates this metrics

type MetricsSample added in v0.4.0 

type MetricsSample struct {

	// rx
	Rx float64 `json:"rx,omitempty"`

	// timestamp
	Timestamp float64 `json:"timestamp,omitempty"`

	// tx
	Tx float64 `json:"tx,omitempty"`
}

MetricsSample metrics sample

swagger:model metricsSample

func (*MetricsSample) ContextValidate added in v0.4.0 

func (m *MetricsSample) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this metrics sample based on context it is used

func (*MetricsSample) MarshalBinary added in v0.4.0 

func (m *MetricsSample) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MetricsSample) UnmarshalBinary added in v0.4.0 

func (m *MetricsSample) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MetricsSample) Validate added in v0.4.0 

func (m *MetricsSample) Validate(formats strfmt.Registry) error

Validate validates this metrics sample

type Overview added in v0.4.0 

type Overview struct {

	// account limited
	AccountLimited bool `json:"accountLimited,omitempty"`

	// environments
	Environments []*EnvironmentAndResources `json:"environments"`
}

Overview overview

swagger:model overview

func (*Overview) ContextValidate added in v0.4.0 

func (m *Overview) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this overview based on the context it is used

func (*Overview) MarshalBinary added in v0.4.0 

func (m *Overview) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Overview) UnmarshalBinary added in v0.4.0 

func (m *Overview) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Overview) Validate added in v0.4.0 

func (m *Overview) Validate(formats strfmt.Registry) error

Validate validates this overview

type Principal 

type Principal struct {

	// admin
	Admin bool `json:"admin,omitempty"`

	// email
	Email string `json:"email,omitempty"`

	// id
	ID int64 `json:"id,omitempty"`

	// limitless
	Limitless bool `json:"limitless,omitempty"`

	// token
	Token string `json:"token,omitempty"`
}

Principal principal

swagger:model principal

func (*Principal) ContextValidate 

func (m *Principal) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this principal based on context it is used

func (*Principal) MarshalBinary 

func (m *Principal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Principal) UnmarshalBinary 

func (m *Principal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Principal) Validate 

func (m *Principal) Validate(formats strfmt.Registry) error

Validate validates this principal

type Share 

type Share struct {

	// activity
	Activity SparkData `json:"activity,omitempty"`

	// backend mode
	BackendMode string `json:"backendMode,omitempty"`

	// backend proxy endpoint
	BackendProxyEndpoint string `json:"backendProxyEndpoint,omitempty"`

	// created at
	CreatedAt int64 `json:"createdAt,omitempty"`

	// frontend endpoint
	FrontendEndpoint string `json:"frontendEndpoint,omitempty"`

	// frontend selection
	FrontendSelection string `json:"frontendSelection,omitempty"`

	// limited
	Limited bool `json:"limited,omitempty"`

	// reserved
	Reserved bool `json:"reserved,omitempty"`

	// share mode
	ShareMode string `json:"shareMode,omitempty"`

	// share token
	ShareToken string `json:"shareToken,omitempty"`

	// updated at
	UpdatedAt int64 `json:"updatedAt,omitempty"`

	// z Id
	ZID string `json:"zId,omitempty"`
}

Share share

swagger:model share

func (*Share) ContextValidate 

func (m *Share) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this share based on the context it is used

func (*Share) MarshalBinary 

func (m *Share) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Share) UnmarshalBinary 

func (m *Share) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Share) Validate 

func (m *Share) Validate(formats strfmt.Registry) error

Validate validates this share

type ShareRequest 

type ShareRequest struct {

	// access grants
	AccessGrants []string `json:"accessGrants"`

	// auth scheme
	AuthScheme string `json:"authScheme,omitempty"`

	// auth users
	AuthUsers []*AuthUser `json:"authUsers"`

	// backend mode
	// Enum: [proxy web tcpTunnel udpTunnel caddy drive socks vpn]
	BackendMode string `json:"backendMode,omitempty"`

	// backend proxy endpoint
	BackendProxyEndpoint string `json:"backendProxyEndpoint,omitempty"`

	// env z Id
	EnvZID string `json:"envZId,omitempty"`

	// frontend selection
	FrontendSelection []string `json:"frontendSelection"`

	// oauth authorization check interval
	OauthAuthorizationCheckInterval string `json:"oauthAuthorizationCheckInterval,omitempty"`

	// oauth email domains
	OauthEmailDomains []string `json:"oauthEmailDomains"`

	// oauth provider
	// Enum: [github google]
	OauthProvider string `json:"oauthProvider,omitempty"`

	// permission mode
	// Enum: [open closed]
	PermissionMode string `json:"permissionMode,omitempty"`

	// reserved
	Reserved bool `json:"reserved,omitempty"`

	// share mode
	// Enum: [public private]
	ShareMode string `json:"shareMode,omitempty"`

	// unique name
	UniqueName string `json:"uniqueName,omitempty"`
}

ShareRequest share request

swagger:model shareRequest

func (*ShareRequest) ContextValidate 

func (m *ShareRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this share request based on the context it is used

func (*ShareRequest) MarshalBinary 

func (m *ShareRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ShareRequest) UnmarshalBinary 

func (m *ShareRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ShareRequest) Validate 

func (m *ShareRequest) Validate(formats strfmt.Registry) error

Validate validates this share request

type ShareResponse 

type ShareResponse struct {

	// frontend proxy endpoints
	FrontendProxyEndpoints []string `json:"frontendProxyEndpoints"`

	// share token
	ShareToken string `json:"shareToken,omitempty"`
}

ShareResponse share response

swagger:model shareResponse

func (*ShareResponse) ContextValidate 

func (m *ShareResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this share response based on context it is used

func (*ShareResponse) MarshalBinary 

func (m *ShareResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ShareResponse) UnmarshalBinary 

func (m *ShareResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ShareResponse) Validate 

func (m *ShareResponse) Validate(formats strfmt.Registry) error

Validate validates this share response

type Shares 

type Shares []*Share

Shares shares

swagger:model shares

func (Shares) ContextValidate 

func (m Shares) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this shares based on the context it is used

func (Shares) Validate 

func (m Shares) Validate(formats strfmt.Registry) error

Validate validates this shares

type SparkData added in v0.4.0 

type SparkData []*SparkDataSample

SparkData spark data

swagger:model sparkData

func (SparkData) ContextValidate added in v0.4.0 

func (m SparkData) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this spark data based on the context it is used

func (SparkData) Validate added in v0.4.0 

func (m SparkData) Validate(formats strfmt.Registry) error

Validate validates this spark data

type SparkDataSample added in v0.4.0 

type SparkDataSample struct {

	// rx
	Rx float64 `json:"rx,omitempty"`

	// tx
	Tx float64 `json:"tx,omitempty"`
}

SparkDataSample spark data sample

swagger:model sparkDataSample

func (*SparkDataSample) ContextValidate added in v0.4.0 

func (m *SparkDataSample) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this spark data sample based on context it is used

func (*SparkDataSample) MarshalBinary added in v0.4.0 

func (m *SparkDataSample) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SparkDataSample) UnmarshalBinary added in v0.4.0 

func (m *SparkDataSample) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SparkDataSample) Validate added in v0.4.0 

func (m *SparkDataSample) Validate(formats strfmt.Registry) error

Validate validates this spark data sample

type Version 

type Version string

Version version

swagger:model version

func (Version) ContextValidate 

func (m Version) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this version based on context it is used

func (Version) Validate 

func (m Version) Validate(formats strfmt.Registry) error

Validate validates this version

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.