groups

Documentation

Overview

Code generated by "make api"; DO NOT EDIT.

Code generated by "make api"; DO NOT EDIT.

Index

• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) AddMembers(ctx context.Context, groupId string, version uint32, memberIds []string, ...) (*GroupUpdateResult, error)
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) Create(ctx context.Context, scopeId string, opt ...Option) (*GroupCreateResult, error)
  • func (c *Client) Delete(ctx context.Context, groupId string, opt ...Option) (*GroupDeleteResult, error)
  • func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*GroupListResult, error)
  • func (c *Client) Read(ctx context.Context, groupId string, opt ...Option) (*GroupReadResult, error)
  • func (c *Client) RemoveMembers(ctx context.Context, groupId string, version uint32, memberIds []string, ...) (*GroupUpdateResult, error)
  • func (c *Client) SetMembers(ctx context.Context, groupId string, version uint32, memberIds []string, ...) (*GroupUpdateResult, error)
  • func (c *Client) Update(ctx context.Context, groupId string, version uint32, opt ...Option) (*GroupUpdateResult, error)
• type Group
  • func (n Group) ResponseBody() *bytes.Buffer
  • func (n Group) ResponseMap() map[string]interface{}
• type GroupCreateResult
• type GroupDeleteResult
  • func (n GroupDeleteResult) GetResponseBody() *bytes.Buffer
  • func (n GroupDeleteResult) GetResponseMap() map[string]interface{}
• type GroupListResult
  • func (n GroupListResult) GetItems() interface{}
  • func (n GroupListResult) GetResponseBody() *bytes.Buffer
  • func (n GroupListResult) GetResponseMap() map[string]interface{}
• type GroupReadResult
  • func (n GroupReadResult) GetItem() interface{}
  • func (n GroupReadResult) GetResponseBody() *bytes.Buffer
  • func (n GroupReadResult) GetResponseMap() map[string]interface{}
• type GroupUpdateResult
• type Member
• type Option
  • func DefaultDescription() Option
  • func DefaultName() Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithDescription(inDescription string) Option
  • func WithName(inName string) Option

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a client for this collection

func NewClient

func NewClient(c *api.Client) *Client

Creates a new client for this collection. The submitted API client is cloned; modifications to it after generating this client will not have effect. If you need to make changes to the underlying API client, use ApiClient() to access it.

func (*Client) AddMembers

func (c *Client) AddMembers(ctx context.Context, groupId string, version uint32, memberIds []string, opt ...Option) (*GroupUpdateResult, error)

func (*Client) ApiClient

func (c *Client) ApiClient() *api.Client

ApiClient returns the underlying API client

func (*Client) Create

func (c *Client) Create(ctx context.Context, scopeId string, opt ...Option) (*GroupCreateResult, error)

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, groupId string, opt ...Option) (*GroupDeleteResult, error)

func (*Client) List

func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*GroupListResult, error)

func (*Client) Read

func (c *Client) Read(ctx context.Context, groupId string, opt ...Option) (*GroupReadResult, error)

func (*Client) RemoveMembers

func (c *Client) RemoveMembers(ctx context.Context, groupId string, version uint32, memberIds []string, opt ...Option) (*GroupUpdateResult, error)

func (*Client) SetMembers

func (c *Client) SetMembers(ctx context.Context, groupId string, version uint32, memberIds []string, opt ...Option) (*GroupUpdateResult, error)

func (*Client) Update

func (c *Client) Update(ctx context.Context, groupId string, version uint32, opt ...Option) (*GroupUpdateResult, error)

type Group

type Group struct {
	Id          string            `json:"id,omitempty"`
	ScopeId     string            `json:"scope_id,omitempty"`
	Scope       *scopes.ScopeInfo `json:"scope,omitempty"`
	Name        string            `json:"name,omitempty"`
	Description string            `json:"description,omitempty"`
	CreatedTime time.Time         `json:"created_time,omitempty"`
	UpdatedTime time.Time         `json:"updated_time,omitempty"`
	Version     uint32            `json:"version,omitempty"`
	MemberIds   []string          `json:"member_ids,omitempty"`
	Members     []*Member         `json:"members,omitempty"`
	// contains filtered or unexported fields
}

func (Group) ResponseBody

func (n Group) ResponseBody() *bytes.Buffer

func (Group) ResponseMap

func (n Group) ResponseMap() map[string]interface{}

type GroupCreateResult

type GroupCreateResult = GroupReadResult

type GroupDeleteResult

type GroupDeleteResult struct {
	// contains filtered or unexported fields
}

func (GroupDeleteResult) GetResponseBody

func (n GroupDeleteResult) GetResponseBody() *bytes.Buffer

func (GroupDeleteResult) GetResponseMap

func (n GroupDeleteResult) GetResponseMap() map[string]interface{}

type GroupListResult

type GroupListResult struct {
	Items []*Group
	// contains filtered or unexported fields
}

func (GroupListResult) GetItems

func (n GroupListResult) GetItems() interface{}

func (GroupListResult) GetResponseBody

func (n GroupListResult) GetResponseBody() *bytes.Buffer

func (GroupListResult) GetResponseMap

func (n GroupListResult) GetResponseMap() map[string]interface{}

type GroupReadResult

type GroupReadResult struct {
	Item *Group
	// contains filtered or unexported fields
}

func (GroupReadResult) GetItem

func (n GroupReadResult) GetItem() interface{}

func (GroupReadResult) GetResponseBody

func (n GroupReadResult) GetResponseBody() *bytes.Buffer

func (GroupReadResult) GetResponseMap

func (n GroupReadResult) GetResponseMap() map[string]interface{}

type GroupUpdateResult

type GroupUpdateResult = GroupReadResult

type Member

type Member struct {
	Id      string `json:"id,omitempty"`
	ScopeId string `json:"scope_id,omitempty"`
}

type Option

type Option func(*options)

Option is a func that sets optional attributes for a call. This does not need to be used directly, but instead option arguments are built from the functions in this package. WithX options set a value to that given in the argument; DefaultX options indicate that the value should be set to its default. When an API call is made options are processed in ther order they appear in the function call, so for a given argument X, a succession of WithX or DefaultX calls will result in the last call taking effect.

func DefaultDescription

func DefaultDescription() Option

func DefaultName

func DefaultName() Option

func WithAutomaticVersioning

func WithAutomaticVersioning(enable bool) Option

If set, and if the version is zero during an update, the API will perform a fetch to get the current version of the resource and populate it during the update call. This is convenient but opens up the possibility for subtle order-of-modification issues, so use carefully.

func WithDescription

func WithDescription(inDescription string) Option

func WithName

func WithName(inName string) Option