// Code generated by "make api"; DO NOT EDIT. // Copyright (c) HashiCorp, Inc. // SPDX-License-Identifier: MPL-2.0 package groups import ( "context" "encoding/json" "errors" "fmt" "net/url" "slices" "strconv" "time" "github.com/hashicorp/boundary/api" "github.com/hashicorp/boundary/api/scopes" ) 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 GroupReadResult struct { Item *Group Response *api.Response } func (n GroupReadResult) GetItem() *Group { return n.Item } func (n GroupReadResult) GetResponse() *api.Response { return n.Response } type GroupCreateResult = GroupReadResult type GroupUpdateResult = GroupReadResult type GroupDeleteResult struct { Response *api.Response } // GetItem will always be nil for GroupDeleteResult func (n GroupDeleteResult) GetItem() any { return nil } func (n GroupDeleteResult) GetResponse() *api.Response { return n.Response } 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 // The following fields are used for cached information when client-directed // pagination is used. recursive bool pageSize uint32 scopeId string allRemovedIds []string } func (n GroupListResult) GetItems() []*Group { return n.Items } func (n GroupListResult) GetEstItemCount() uint { return n.EstItemCount } func (n GroupListResult) GetRemovedIds() []string { return n.RemovedIds } func (n GroupListResult) GetListToken() string { return n.ListToken } func (n GroupListResult) GetResponseType() string { return n.ResponseType } func (n GroupListResult) GetResponse() *api.Response { return n.Response } // Client is a client for this collection type Client struct { client *api.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 NewClient(c *api.Client) *Client { return &Client{client: c.Clone()} } // ApiClient returns the underlying API client func (c *Client) ApiClient() *api.Client { return c.client } func (c *Client) Create(ctx context.Context, scopeId string, opt ...Option) (*GroupCreateResult, error) { if scopeId == "" { return nil, fmt.Errorf("empty scopeId value passed into Create request") } opts, apiOpts := getOpts(opt...) if c.client == nil { return nil, fmt.Errorf("nil client") } opts.postMap["scope_id"] = scopeId req, err := c.client.NewRequest(ctx, "POST", "groups", opts.postMap, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating Create request: %w", err) } if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req) if err != nil { return nil, fmt.Errorf("error performing client request during Create call: %w", err) } target := new(GroupCreateResult) target.Item = new(Group) apiErr, err := resp.Decode(target.Item) if err != nil { return nil, fmt.Errorf("error decoding Create response: %w", err) } if apiErr != nil { return nil, apiErr } target.Response = resp return target, nil } func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*GroupReadResult, error) { if id == "" { return nil, fmt.Errorf("empty id value passed into Read request") } if c.client == nil { return nil, fmt.Errorf("nil client") } opts, apiOpts := getOpts(opt...) req, err := c.client.NewRequest(ctx, "GET", fmt.Sprintf("groups/%s", url.PathEscape(id)), nil, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating Read request: %w", err) } if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req, apiOpts...) if err != nil { return nil, fmt.Errorf("error performing client request during Read call: %w", err) } target := new(GroupReadResult) target.Item = new(Group) apiErr, err := resp.Decode(target.Item) if err != nil { return nil, fmt.Errorf("error decoding Read response: %w", err) } if apiErr != nil { return nil, apiErr } target.Response = resp return target, nil } func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*GroupUpdateResult, error) { if id == "" { return nil, fmt.Errorf("empty id value passed into Update request") } if c.client == nil { return nil, fmt.Errorf("nil client") } opts, apiOpts := getOpts(opt...) if version == 0 { if !opts.withAutomaticVersioning { return nil, errors.New("zero version number passed into Update request and automatic versioning not specified") } existingTarget, existingErr := c.Read(ctx, id, append([]Option{WithSkipCurlOutput(true)}, opt...)...) if existingErr != nil { if api.AsServerError(existingErr) != nil { return nil, fmt.Errorf("error from controller when performing initial check-and-set read: %w", existingErr) } return nil, fmt.Errorf("error performing initial check-and-set read: %w", existingErr) } if existingTarget == nil { return nil, errors.New("nil resource response found when performing initial check-and-set read") } if existingTarget.Item == nil { return nil, errors.New("nil resource found when performing initial check-and-set read") } version = existingTarget.Item.Version } opts.postMap["version"] = version req, err := c.client.NewRequest(ctx, "PATCH", fmt.Sprintf("groups/%s", url.PathEscape(id)), opts.postMap, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating Update request: %w", err) } if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req) if err != nil { return nil, fmt.Errorf("error performing client request during Update call: %w", err) } target := new(GroupUpdateResult) target.Item = new(Group) apiErr, err := resp.Decode(target.Item) if err != nil { return nil, fmt.Errorf("error decoding Update response: %w", err) } if apiErr != nil { return nil, apiErr } target.Response = resp return target, nil } func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*GroupDeleteResult, error) { if id == "" { return nil, fmt.Errorf("empty id value passed into Delete request") } if c.client == nil { return nil, fmt.Errorf("nil client") } opts, apiOpts := getOpts(opt...) req, err := c.client.NewRequest(ctx, "DELETE", fmt.Sprintf("groups/%s", url.PathEscape(id)), nil, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating Delete request: %w", err) } if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req) if err != nil { return nil, fmt.Errorf("error performing client request during Delete call: %w", err) } apiErr, err := resp.Decode(nil) if err != nil { return nil, fmt.Errorf("error decoding Delete response: %w", err) } if apiErr != nil { return nil, apiErr } target := &GroupDeleteResult{ Response: resp, } return target, nil } func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*GroupListResult, error) { if scopeId == "" { return nil, fmt.Errorf("empty scopeId value passed into List request") } if c.client == nil { return nil, fmt.Errorf("nil client") } opts, apiOpts := getOpts(opt...) opts.queryMap["scope_id"] = scopeId requestPath := "groups" if opts.withResourcePathOverride != "" { requestPath = opts.withResourcePathOverride } req, err := c.client.NewRequest(ctx, "GET", requestPath, nil, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating List request: %w", err) } if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req) if err != nil { return nil, fmt.Errorf("error performing client request during List call: %w", err) } target := new(GroupListResult) apiErr, err := resp.Decode(target) if err != nil { return nil, fmt.Errorf("error decoding List response: %w", err) } if apiErr != nil { return nil, apiErr } target.Response = resp if target.ResponseType == "complete" || target.ResponseType == "" { return target, nil } // In case we shortcut out due to client directed pagination, ensure these // are set target.recursive = opts.withRecursive target.pageSize = opts.withPageSize target.scopeId = scopeId target.allRemovedIds = target.RemovedIds if opts.withClientDirectedPagination { return target, nil } allItems := make([]*Group, 0, target.EstItemCount) allItems = append(allItems, target.Items...) // If there are more results, automatically fetch the rest of the results. // idToIndex keeps a map from the ID of an item to its index in target.Items. // This is used to update updated items in-place and remove deleted items // from the result after pagination is done. idToIndex := map[string]int{} for i, item := range allItems { idToIndex[item.Id] = i } // If we're here there are more pages and the client does not want to // paginate on their own; fetch them as this call returns all values. currentPage := target for { nextPage, err := c.ListNextPage(ctx, currentPage, opt...) if err != nil { return nil, fmt.Errorf("error getting next page in List call: %w", err) } for _, item := range nextPage.Items { if i, ok := idToIndex[item.Id]; ok { // Item has already been seen at index i, update in-place allItems[i] = item } else { allItems = append(allItems, item) idToIndex[item.Id] = len(allItems) - 1 } } currentPage = nextPage if currentPage.ResponseType == "complete" { break } } // The current page here is the final page of the results, that is, the // response type is "complete" // Remove items that were deleted since the end of the last iteration. // If a Group has been updated and subsequently removed, we don't want // it to appear both in the Items and RemovedIds, so we remove it from the Items. for _, removedId := range currentPage.RemovedIds { if i, ok := idToIndex[removedId]; ok { // Remove the item at index i without preserving order // https://github.com/golang/go/wiki/SliceTricks#delete-without-preserving-order allItems[i] = allItems[len(allItems)-1] allItems = allItems[:len(allItems)-1] // Update the index of the previously last element idToIndex[allItems[i].Id] = i } } // Sort the results again since in-place updates and deletes // may have shuffled items. We sort by created time descending // (most recently created first), same as the API. slices.SortFunc(allItems, func(i, j *Group) int { return j.CreatedTime.Compare(i.CreatedTime) }) // Since we paginated to the end, we can avoid confusion // for the user by setting the estimated item count to the // length of the items slice. If we don't set this here, it // will equal the value returned in the last response, which is // often much smaller than the total number returned. currentPage.EstItemCount = uint(len(allItems)) // Set items to the full list we have collected here currentPage.Items = allItems // Set the returned value to the last page with calculated values target = currentPage // Finally, since we made at least 2 requests to the server to fulfill this // function call, resp.Body and resp.Map will only contain the most recent response. // Overwrite them with the true response. target.Response.Body.Reset() if err := json.NewEncoder(target.Response.Body).Encode(target); err != nil { return nil, fmt.Errorf("error encoding final JSON list response: %w", err) } if err := json.Unmarshal(target.Response.Body.Bytes(), &target.Response.Map); err != nil { return nil, fmt.Errorf("error encoding final map list response: %w", err) } // Note: the HTTP response body is consumed by resp.Decode in the loop, // so it doesn't need to be updated (it will always be, and has always been, empty). return target, nil } func (c *Client) ListNextPage(ctx context.Context, currentPage *GroupListResult, opt ...Option) (*GroupListResult, error) { if currentPage == nil { return nil, fmt.Errorf("empty currentPage value passed into ListNextPage request") } if currentPage.scopeId == "" { return nil, fmt.Errorf("empty scopeId value in currentPage passed into ListNextPage request") } if c.client == nil { return nil, fmt.Errorf("nil client") } if currentPage.ResponseType == "complete" || currentPage.ResponseType == "" { return nil, fmt.Errorf("no more pages available in ListNextPage request") } opts, apiOpts := getOpts(opt...) opts.queryMap["scope_id"] = currentPage.scopeId // Don't require them to re-specify recursive if currentPage.recursive { opts.queryMap["recursive"] = "true" } if currentPage.pageSize != 0 { opts.queryMap["page_size"] = strconv.FormatUint(uint64(currentPage.pageSize), 10) } requestPath := "groups" if opts.withResourcePathOverride != "" { requestPath = opts.withResourcePathOverride } req, err := c.client.NewRequest(ctx, "GET", requestPath, nil, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating List request: %w", err) } opts.queryMap["list_token"] = currentPage.ListToken if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req) if err != nil { return nil, fmt.Errorf("error performing client request during List call during ListNextPage: %w", err) } nextPage := new(GroupListResult) apiErr, err := resp.Decode(nextPage) if err != nil { return nil, fmt.Errorf("error decoding List response during ListNextPage: %w", err) } if apiErr != nil { return nil, apiErr } // Ensure values are carried forward to the next call nextPage.scopeId = currentPage.scopeId nextPage.recursive = currentPage.recursive nextPage.pageSize = currentPage.pageSize // Cache the removed IDs from this page nextPage.allRemovedIds = append(currentPage.allRemovedIds, nextPage.RemovedIds...) // Set the response body to the current response nextPage.Response = resp // If we're done iterating, pull the full set of removed IDs into the last // response if nextPage.ResponseType == "complete" { // Collect up the last values nextPage.RemovedIds = nextPage.allRemovedIds // For now, removedIds will only be populated if this pagination cycle // was the result of a "refresh" operation (i.e., the caller provided a // list token option to this call). // // Sort to make response deterministic slices.Sort(nextPage.RemovedIds) // Remove any duplicates nextPage.RemovedIds = slices.Compact(nextPage.RemovedIds) } return nextPage, nil } func (c *Client) AddMembers(ctx context.Context, id string, version uint32, memberIds []string, opt ...Option) (*GroupUpdateResult, error) { if id == "" { return nil, fmt.Errorf("empty id value passed into AddMembers request") } if len(memberIds) == 0 { return nil, errors.New("empty memberIds passed into AddMembers request") } if c.client == nil { return nil, errors.New("nil client") } opts, apiOpts := getOpts(opt...) if version == 0 { if !opts.withAutomaticVersioning { return nil, errors.New("zero version number passed into AddMembers request") } existingTarget, existingErr := c.Read(ctx, id, append([]Option{WithSkipCurlOutput(true)}, opt...)...) if existingErr != nil { if api.AsServerError(existingErr) != nil { return nil, fmt.Errorf("error from controller when performing initial check-and-set read: %w", existingErr) } return nil, fmt.Errorf("error performing initial check-and-set read: %w", existingErr) } if existingTarget == nil { return nil, errors.New("nil resource response found when performing initial check-and-set read") } if existingTarget.Item == nil { return nil, errors.New("nil resource found when performing initial check-and-set read") } version = existingTarget.Item.Version } opts.postMap["version"] = version opts.postMap["member_ids"] = memberIds req, err := c.client.NewRequest(ctx, "POST", fmt.Sprintf("groups/%s:add-members", url.PathEscape(id)), opts.postMap, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating AddMembers request: %w", err) } if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req) if err != nil { return nil, fmt.Errorf("error performing client request during AddMembers call: %w", err) } target := new(GroupUpdateResult) target.Item = new(Group) apiErr, err := resp.Decode(target.Item) if err != nil { return nil, fmt.Errorf("error decoding AddMembers response: %w", err) } if apiErr != nil { return nil, apiErr } target.Response = resp return target, nil } func (c *Client) SetMembers(ctx context.Context, id string, version uint32, memberIds []string, opt ...Option) (*GroupUpdateResult, error) { if id == "" { return nil, fmt.Errorf("empty id value passed into SetMembers request") } if c.client == nil { return nil, errors.New("nil client") } opts, apiOpts := getOpts(opt...) if version == 0 { if !opts.withAutomaticVersioning { return nil, errors.New("zero version number passed into SetMembers request") } existingTarget, existingErr := c.Read(ctx, id, append([]Option{WithSkipCurlOutput(true)}, opt...)...) if existingErr != nil { if api.AsServerError(existingErr) != nil { return nil, fmt.Errorf("error from controller when performing initial check-and-set read: %w", existingErr) } return nil, fmt.Errorf("error performing initial check-and-set read: %w", existingErr) } if existingTarget == nil { return nil, errors.New("nil resource response found when performing initial check-and-set read") } if existingTarget.Item == nil { return nil, errors.New("nil resource found when performing initial check-and-set read") } version = existingTarget.Item.Version } opts.postMap["version"] = version opts.postMap["member_ids"] = memberIds req, err := c.client.NewRequest(ctx, "POST", fmt.Sprintf("groups/%s:set-members", url.PathEscape(id)), opts.postMap, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating SetMembers request: %w", err) } if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req) if err != nil { return nil, fmt.Errorf("error performing client request during SetMembers call: %w", err) } target := new(GroupUpdateResult) target.Item = new(Group) apiErr, err := resp.Decode(target.Item) if err != nil { return nil, fmt.Errorf("error decoding SetMembers response: %w", err) } if apiErr != nil { return nil, apiErr } target.Response = resp return target, nil } func (c *Client) RemoveMembers(ctx context.Context, id string, version uint32, memberIds []string, opt ...Option) (*GroupUpdateResult, error) { if id == "" { return nil, fmt.Errorf("empty id value passed into RemoveMembers request") } if len(memberIds) == 0 { return nil, errors.New("empty memberIds passed into RemoveMembers request") } if c.client == nil { return nil, errors.New("nil client") } opts, apiOpts := getOpts(opt...) if version == 0 { if !opts.withAutomaticVersioning { return nil, errors.New("zero version number passed into RemoveMembers request") } existingTarget, existingErr := c.Read(ctx, id, append([]Option{WithSkipCurlOutput(true)}, opt...)...) if existingErr != nil { if api.AsServerError(existingErr) != nil { return nil, fmt.Errorf("error from controller when performing initial check-and-set read: %w", existingErr) } return nil, fmt.Errorf("error performing initial check-and-set read: %w", existingErr) } if existingTarget == nil { return nil, errors.New("nil resource response found when performing initial check-and-set read") } if existingTarget.Item == nil { return nil, errors.New("nil resource found when performing initial check-and-set read") } version = existingTarget.Item.Version } opts.postMap["version"] = version opts.postMap["member_ids"] = memberIds req, err := c.client.NewRequest(ctx, "POST", fmt.Sprintf("groups/%s:remove-members", url.PathEscape(id)), opts.postMap, apiOpts...) if err != nil { return nil, fmt.Errorf("error creating RemoveMembers request: %w", err) } if len(opts.queryMap) > 0 { q := url.Values{} for k, v := range opts.queryMap { q.Add(k, v) } req.URL.RawQuery = q.Encode() } resp, err := c.client.Do(req) if err != nil { return nil, fmt.Errorf("error performing client request during RemoveMembers call: %w", err) } target := new(GroupUpdateResult) target.Item = new(Group) apiErr, err := resp.Decode(target.Item) if err != nil { return nil, fmt.Errorf("error decoding RemoveMembers response: %w", err) } if apiErr != nil { return nil, apiErr } target.Response = resp return target, nil }