note

package

v1.0.0-rc1 Latest Latest Go to latest Published: Oct 23, 2019 License: Apache-2.0 Imports: 13 Imported by: 0

Details

This section is empty.

This section is empty.

func Add(params AddParams) error

Add posts a new message to the specified deployment

func Get(params GetParams) (*models.Note, error)

Get obtains a note from a deployment and note ID

func List(params ListParams) (*models.Notes, error)

List lists all of the notes for the deployment

func Update(params UpdateParams) (*models.Note, error)

Update updates a note from its deployment and note ID

type AddParams struct {
	*api.API

	ID          string
	Type        string
	Message     string
	UserID      string
	Commentator ecctl.Commentator
}

AddParams is consumed by Add.

func (params AddParams) Validate() error

Validate ensures the parameters are valid

type GetParams struct {
	Params
}

GetParams is used on ListNotes

type ListParams struct {
	deployment.Params
}

ListParams is used by List

type Params struct {
	deployment.Params
	NoteID string
}

Params is used on Get and Update Notes

func (params Params) Validate() error

Validate confirms the parmeters are valid

type UpdateParams struct {
	Params
	UserID  string
	Message string
}

UpdateParams is used on ListNotes

func (params UpdateParams) Validate() error

Validate confirms the parmeters are valid