phpapi

Documentation

Index

• type PHPAPI
  • func NewPHPAPI(apitoken string) *PHPAPI
  • func (p *PHPAPI) GetCluster(clusterId string) (types.SubmarinerCluster, error)
  • func (p *PHPAPI) GetClusters(colorCodes []string) ([]types.SubmarinerCluster, error)
  • func (p *PHPAPI) GetEndpoint(clusterId string, cableName string) (types.SubmarinerEndpoint, error)
  • func (p *PHPAPI) GetEndpoints(clusterId string) ([]types.SubmarinerEndpoint, error)
  • func (p *PHPAPI) RemoveCluster(clusterId string) error
  • func (p *PHPAPI) RemoveEndpoint(clusterId, cableName string) error
  • func (p *PHPAPI) SetCluster(cluster types.SubmarinerCluster) error
  • func (p *PHPAPI) SetEndpoint(local types.SubmarinerEndpoint) error
  • func (p *PHPAPI) WatchClusters(ctx context.Context, selfClusterId string, colorCodes []string, ...) error
  • func (p *PHPAPI) WatchEndpoints(ctx context.Context, selfClusterId string, colorCodes []string, ...) error
• type PHPAPISpecification

Types

type PHPAPI

type PHPAPI struct {
	sync.Mutex
	Proto    string
	Server   string
	APIToken string
}

func NewPHPAPI

func NewPHPAPI(apitoken string) *PHPAPI

func (*PHPAPI) GetCluster

func (p *PHPAPI) GetCluster(clusterId string) (types.SubmarinerCluster, error)

func (*PHPAPI) GetClusters

func (p *PHPAPI) GetClusters(colorCodes []string) ([]types.SubmarinerCluster, error)

func (*PHPAPI) GetEndpoint

func (p *PHPAPI) GetEndpoint(clusterId string, cableName string) (types.SubmarinerEndpoint, error)

func (*PHPAPI) GetEndpoints

func (p *PHPAPI) GetEndpoints(clusterId string) ([]types.SubmarinerEndpoint, error)

func (*PHPAPI) RemoveCluster

func (p *PHPAPI) RemoveCluster(clusterId string) error

func (*PHPAPI) RemoveEndpoint

func (p *PHPAPI) RemoveEndpoint(clusterId, cableName string) error

func (*PHPAPI) SetCluster

func (p *PHPAPI) SetCluster(cluster types.SubmarinerCluster) error

func (*PHPAPI) SetEndpoint

func (p *PHPAPI) SetEndpoint(local types.SubmarinerEndpoint) error

func (*PHPAPI) WatchClusters

func (p *PHPAPI) WatchClusters(ctx context.Context, selfClusterId string, colorCodes []string, onChange func(cluster types.SubmarinerCluster, deleted bool) error) error

func (*PHPAPI) WatchEndpoints

func (p *PHPAPI) WatchEndpoints(ctx context.Context, selfClusterId string, colorCodes []string, onChange func(endpoint types.SubmarinerEndpoint, deleted bool) error) error

type PHPAPISpecification

type PHPAPISpecification struct {
	Proto  string
	Server string
}