proxies

Documentation

Index

• func DeleteByID(client newclient.Client, spaceID string, ID string) error
• func Get(client newclient.Client, spaceID string, proxyQuery ProxiesQuery) (*resources.Resources[*Proxy], error)
• type ProxiesQuery
• type Proxy
  • func Add(client newclient.Client, proxy *Proxy) (*Proxy, error)
  • func GetAll(client newclient.Client, spaceID string) ([]*Proxy, error)
  • func GetByID(client newclient.Client, spaceID string, ID string) (*Proxy, error)
  • func NewProxy(name string, hostname string, username string, password *core.SensitiveValue) *Proxy
  • func Update(client newclient.Client, resource *Proxy) (*Proxy, error)
  • func (p *Proxy) GetHost() string
  • func (p *Proxy) GetName() string
  • func (p *Proxy) GetPassword() *core.SensitiveValue
  • func (p *Proxy) GetPort() int
  • func (p *Proxy) GetSpaceID() string
  • func (p *Proxy) GetUsername() string
  • func (p *Proxy) SetHost(host string)
  • func (p *Proxy) SetName(name string)
  • func (p *Proxy) SetPassword(password *core.SensitiveValue)
  • func (p *Proxy) SetPort(port int)
  • func (p *Proxy) SetSpaceID(spaceID string)
  • func (p *Proxy) SetUsername(username string)
• type ProxyService
  • func NewProxyService(sling *sling.Sling, uriTemplate string) *ProxyService
  • func (p *ProxyService) GetAll() ([]*Proxy, error)
  • func (p *ProxyService) GetById(id string) (*Proxy, error)

Functions

func DeleteByID

func DeleteByID(client newclient.Client, spaceID string, ID string) error

DeleteByID deletes the machine proxy that matches the input ID.

func Get

func Get(client newclient.Client, spaceID string, proxyQuery ProxiesQuery) (*resources.Resources[*Proxy], error)

Get return the machine proxies that match the provided proxies query.

Types

type ProxiesQuery

type ProxiesQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	PartialName string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Skip        int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take        int      `uri:"take,omitempty" url:"take,omitempty"`
}

type Proxy

type Proxy struct {
	Name      string               `json:"Name" validate:"required,notblank"`
	SpaceID   string               `json:"SpaceId,omitempty"`
	Host      string               `json:"Host,omitempty"`
	Port      int                  `json:"Port,omitempty"`
	Username  string               `json:"Username,omitempty"`
	Password  *core.SensitiveValue `json:"Password,omitempty"`
	ProxyType string               `json:"ProxyType,omitempty" validate:"oneof=HTTP"`

	resources.Resource
}

func Add

func Add(client newclient.Client, proxy *Proxy) (*Proxy, error)

Add creates a new machine proxy.

func GetAll

func GetAll(client newclient.Client, spaceID string) ([]*Proxy, error)

GetAll returns all machine proxies. If an error occurs, it returns nil.

func GetByID

func GetByID(client newclient.Client, spaceID string, ID string) (*Proxy, error)

GetByID returns the machine proxy that matches the input ID.

func NewProxy

func NewProxy(name string, hostname string, username string, password *core.SensitiveValue) *Proxy

func Update

func Update(client newclient.Client, resource *Proxy) (*Proxy, error)

Update modifies a machine proxy based on the one provided as input.

func (*Proxy) GetHost

func (p *Proxy) GetHost() string

func (*Proxy) GetName

func (p *Proxy) GetName() string

func (*Proxy) GetPassword

func (p *Proxy) GetPassword() *core.SensitiveValue

func (*Proxy) GetPort

func (p *Proxy) GetPort() int

func (*Proxy) GetSpaceID

func (p *Proxy) GetSpaceID() string

func (*Proxy) GetUsername

func (p *Proxy) GetUsername() string

func (*Proxy) SetHost

func (p *Proxy) SetHost(host string)

func (*Proxy) SetName

func (p *Proxy) SetName(name string)

func (*Proxy) SetPassword

func (p *Proxy) SetPassword(password *core.SensitiveValue)

func (*Proxy) SetPort

func (p *Proxy) SetPort(port int)

func (*Proxy) SetSpaceID

func (p *Proxy) SetSpaceID(spaceID string)

func (*Proxy) SetUsername

func (p *Proxy) SetUsername(username string)

type ProxyService

type ProxyService struct {
	services.CanDeleteService
}

func NewProxyService

func NewProxyService(sling *sling.Sling, uriTemplate string) *ProxyService

func (*ProxyService) GetAll

func (p *ProxyService) GetAll() ([]*Proxy, error)

Deprecated: use proxies.GetAll

func (*ProxyService) GetById

func (p *ProxyService) GetById(id string) (*Proxy, error)

Deprecated: use proxies.GetByID