groups

package
v0.0.53 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 30, 2024 License: MPL-2.0 Imports: 11 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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, id 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, id string, opt ...Option) (*GroupDeleteResult, error)

func (*Client) List 

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

func (*Client) ListNextPage added in v0.0.53 

func (c *Client) ListNextPage(ctx context.Context, currentPage *GroupListResult, opt ...Option) (*GroupListResult, error)

func (*Client) Read 

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

func (*Client) RemoveMembers 

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

func (*Client) SetMembers 

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

func (*Client) Update 

func (c *Client) Update(ctx context.Context, id 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"`
	AuthorizedActions []string          `json:"authorized_actions,omitempty"`
}

type GroupCreateResult 

type GroupCreateResult = GroupReadResult

type GroupDeleteResult 

type GroupDeleteResult struct {
	Response *api.Response
}

func (GroupDeleteResult) GetItem added in v0.0.10 

func (n GroupDeleteResult) GetItem() any

GetItem will always be nil for GroupDeleteResult

func (GroupDeleteResult) GetResponse added in v0.0.7 

func (n GroupDeleteResult) GetResponse() *api.Response

type GroupListResult 

type GroupListResult struct {
	Items        []*Group `json:"items,omitempty"`
	EstItemCount uint     `json:"est_item_count,omitempty"`
	RemovedIds   []string `json:"removed_ids,omitempty"`
	ListToken    string   `json:"list_token,omitempty"`
	ResponseType string   `json:"response_type,omitempty"`
	Response     *api.Response
	// contains filtered or unexported fields
}

func (GroupListResult) GetEstItemCount added in v0.0.44 

func (n GroupListResult) GetEstItemCount() uint

func (GroupListResult) GetItems 

func (n GroupListResult) GetItems() []*Group

func (GroupListResult) GetListToken added in v0.0.44 

func (n GroupListResult) GetListToken() string

func (GroupListResult) GetRemovedIds added in v0.0.44 

func (n GroupListResult) GetRemovedIds() []string

func (GroupListResult) GetResponse added in v0.0.7 

func (n GroupListResult) GetResponse() *api.Response

func (GroupListResult) GetResponseType added in v0.0.44 

func (n GroupListResult) GetResponseType() string

type GroupReadResult 

type GroupReadResult struct {
	Item     *Group
	Response *api.Response
}

func (GroupReadResult) GetItem 

func (n GroupReadResult) GetItem() *Group

func (GroupReadResult) GetResponse added in v0.0.7 

func (n GroupReadResult) GetResponse() *api.Response

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 the 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 WithClientDirectedPagination added in v0.0.53 

func WithClientDirectedPagination(with bool) Option

WithClientDirectedPagination tells the List function to return only the first page, if more pages are available

func WithDescription 

func WithDescription(inDescription string) Option

func WithFilter added in v0.0.6 

func WithFilter(filter string) Option

WithFilter tells the API to filter the items returned using the provided filter term. The filter should be in a format supported by hashicorp/go-bexpr.

func WithListToken added in v0.0.44 

func WithListToken(listToken string) Option

WithListToken tells the API to use the provided list token for listing operations on this resource.

func WithName 

func WithName(inName string) Option

func WithPageSize added in v0.0.53 

func WithPageSize(with uint32) Option

WithPageSize controls the size of pages used during List

func WithRecursive added in v0.0.4 

func WithRecursive(recurse bool) Option

WithRecursive tells the API to use recursion for listing operations on this resource

func WithResourcePathOverride added in v0.0.53 

func WithResourcePathOverride(path string) Option

WithResourcePathOverride tells the API to use the provided resource path

func WithSkipCurlOutput added in v0.0.4 

func WithSkipCurlOutput(skip bool) Option

WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.