scopes

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) ApiClient() *api.Client
  • func (c *Client) Create(ctx context.Context, scopeId string, opt ...Option) (*ScopeCreateResult, error)
  • func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*ScopeDeleteResult, error)
  • func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*ScopeListResult, error)
  • func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*ScopeReadResult, error)
  • func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*ScopeUpdateResult, error)
• type Option
  • func DefaultDescription() Option
  • func DefaultName() Option
  • func DefaultPrimaryAuthMethodId() Option
  • func DefaultSkipAdminRoleCreation() Option
  • func DefaultSkipDefaultRoleCreation() Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithDescription(inDescription string) Option
  • func WithFilter(filter string) Option
  • func WithName(inName string) Option
  • func WithPrimaryAuthMethodId(inPrimaryAuthMethodId string) Option
  • func WithRecursive(recurse bool) Option
  • func WithSkipAdminRoleCreation(inSkipAdminRoleCreation bool) Option
  • func WithSkipCurlOutput(skip bool) Option
  • func WithSkipDefaultRoleCreation(inSkipDefaultRoleCreation bool) Option
• type Scope
• type ScopeCreateResult
• type ScopeDeleteResult
  • func (n ScopeDeleteResult) GetItem() interface{}
  • func (n ScopeDeleteResult) GetResponse() *api.Response
• type ScopeInfo
• type ScopeListResult
  • func (n ScopeListResult) GetItems() []*Scope
  • func (n ScopeListResult) GetResponse() *api.Response
• type ScopeReadResult
  • func (n ScopeReadResult) GetItem() *Scope
  • func (n ScopeReadResult) GetResponse() *api.Response
• type ScopeUpdateResult

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) 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) (*ScopeCreateResult, error)

func (*Client) Delete

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

func (*Client) List

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

func (*Client) Read

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

func (*Client) Update

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

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 DefaultPrimaryAuthMethodId

func DefaultPrimaryAuthMethodId() Option

func DefaultSkipAdminRoleCreation

func DefaultSkipAdminRoleCreation() Option

func DefaultSkipDefaultRoleCreation

func DefaultSkipDefaultRoleCreation() 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 WithFilter

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 WithName

func WithName(inName string) Option

func WithPrimaryAuthMethodId

func WithPrimaryAuthMethodId(inPrimaryAuthMethodId string) Option

func WithRecursive

func WithRecursive(recurse bool) Option

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

func WithSkipAdminRoleCreation

func WithSkipAdminRoleCreation(inSkipAdminRoleCreation bool) Option

func WithSkipCurlOutput

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.

func WithSkipDefaultRoleCreation

func WithSkipDefaultRoleCreation(inSkipDefaultRoleCreation bool) Option

type Scope

type Scope struct {
	Id                          string              `json:"id,omitempty"`
	ScopeId                     string              `json:"scope_id,omitempty"`
	Scope                       *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"`
	Type                        string              `json:"type,omitempty"`
	PrimaryAuthMethodId         string              `json:"primary_auth_method_id,omitempty"`
	AuthorizedActions           []string            `json:"authorized_actions,omitempty"`
	AuthorizedCollectionActions map[string][]string `json:"authorized_collection_actions,omitempty"`
	// contains filtered or unexported fields
}

type ScopeCreateResult

type ScopeCreateResult = ScopeReadResult

type ScopeDeleteResult

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

func (ScopeDeleteResult) GetItem

func (n ScopeDeleteResult) GetItem() interface{}

GetItem will always be nil for ScopeDeleteResult

func (ScopeDeleteResult) GetResponse

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

type ScopeInfo

type ScopeInfo struct {
	Id            string `json:"id,omitempty"`
	Type          string `json:"type,omitempty"`
	Name          string `json:"name,omitempty"`
	Description   string `json:"description,omitempty"`
	ParentScopeId string `json:"parent_scope_id,omitempty"`
}

type ScopeListResult

type ScopeListResult struct {
	Items []*Scope
	// contains filtered or unexported fields
}

func (ScopeListResult) GetItems

func (n ScopeListResult) GetItems() []*Scope

func (ScopeListResult) GetResponse

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

type ScopeReadResult

type ScopeReadResult struct {
	Item *Scope
	// contains filtered or unexported fields
}

func (ScopeReadResult) GetItem

func (n ScopeReadResult) GetItem() *Scope

func (ScopeReadResult) GetResponse

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

type ScopeUpdateResult

type ScopeUpdateResult = ScopeReadResult