Documentation
¶
Index ¶
- func AddBlessing(params AddBlessingParams) error
- func Create(params CreateParams) error
- func Delete(params DeleteParams) error
- func List(params ListParams) (*models.RoleAggregates, error)
- func SetBlessings(params SetBlessingsParams) error
- func Show(params ShowParams) (*models.RoleAggregate, error)
- func Update(params UpdateParams) error
- type AddBlessingParams
- type CreateParams
- type DeleteParams
- type ListParams
- type SetBlessingsParams
- type ShowParams
- type UpdateParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddBlessing ¶
func AddBlessing(params AddBlessingParams) error
AddBlessing adds a role blessing to a runner ID.
func List ¶
func List(params ListParams) (*models.RoleAggregates, error)
List returns the platform's roles
func SetBlessings ¶
func SetBlessings(params SetBlessingsParams) error
SetBlessings sets a role blessing definitions, the update uses PUT meaning it does not require a Role with the current + updated data, only requiring the changes which want to be updated.
func Show ¶
func Show(params ShowParams) (*models.RoleAggregate, error)
Show returns a platform's role by ID
func Update ¶
func Update(params UpdateParams) error
Update updates a role definition, the update uses PUT meaning it does not require a Role with the current + updated data, only requiring the changes which want to be updated
Types ¶
type AddBlessingParams ¶
type AddBlessingParams struct {
*api.API
Blessing *models.Blessing
RunnerID string
ID string
Region string
}
AddBlessingParams is consumed by AddBlessing.
func (AddBlessingParams) Validate ¶
func (params AddBlessingParams) Validate() error
Validate ensures the parameters are usable.
type CreateParams ¶
type CreateParams struct {
*api.API
Role *models.RoleAggregateCreateData
Region string
}
CreateParams is consumed by Create.
func (CreateParams) Validate ¶
func (params CreateParams) Validate() error
Validate ensures the parameters are usable
type DeleteParams ¶
DeleteParams is consumed by Delete.
func (DeleteParams) Validate ¶
func (params DeleteParams) Validate() error
Validate ensures the parameters are usable.
type ListParams ¶
ListParams is consumed by List.
func (ListParams) Validate ¶
func (params ListParams) Validate() error
Validate ensures the parameters are valid
type SetBlessingsParams ¶
SetBlessingsParams is consumed by SetBlessings.
func (SetBlessingsParams) Validate ¶
func (params SetBlessingsParams) Validate() error
Validate ensures the parameters are usable.
type ShowParams ¶
ShowParams is consumed by Show.
func (ShowParams) Validate ¶
func (params ShowParams) Validate() error
Validate ensures the parameters are valid
Source Files