workers

Documentation

Index

• func Add(client newclient.Client, worker *machines.Worker) (*machines.Worker, error)
• func DeleteByID(client newclient.Client, spaceID string, ID string) error
• func Get(client newclient.Client, spaceID string, workersQuery machines.WorkersQuery) (*resources.Resources[*machines.Worker], error)
• func GetAll(client newclient.Client, spaceID string) ([]*machines.Worker, error)
• func GetByID(client newclient.Client, spaceID string, ID string) (*machines.Worker, error)
• func Update(client newclient.Client, worker *machines.Worker) (*machines.Worker, error)

Functions

func Add

func Add(client newclient.Client, worker *machines.Worker) (*machines.Worker, error)

Add creates a new worker.

func DeleteByID

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

DeleteByID deletes the worker based on the ID provided.

func Get

func Get(client newclient.Client, spaceID string, workersQuery machines.WorkersQuery) (*resources.Resources[*machines.Worker], error)

Get returns a collection of workers based on the criteria defined by its input query parameter. If an error occurs, an empty collection is returned along with the associated error.

func GetAll

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

GetAll returns all workers. If an error occurs, it returns nil.

func GetByID

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

GetByID returns the worker that matches the input ID. If one cannot be found, it returns nil and an error.

func Update

func Update(client newclient.Client, worker *machines.Worker) (*machines.Worker, error)

Update updates an existing machine in Octopus Deploy