scopes

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: 10 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttachStoragePolicyResult added in v0.0.45 

type AttachStoragePolicyResult = ScopeReadResult

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) AttachStoragePolicy added in v0.0.45 

func (c *Client) AttachStoragePolicy(ctx context.Context, scopeId string, version uint32, storagePolicyId string, opt ...Option) (*AttachStoragePolicyResult, error)

AttachStoragePolicy attaches the provided storagePolicyId to the provided scopeId.

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) DestroyKeyVersion added in v0.0.32 

func (c *Client) DestroyKeyVersion(ctx context.Context, scopeId string, keyVersionId string, opt ...Option) (*KeyVersionDestructionResult, error)

func (*Client) DetachStoragePolicy added in v0.0.45 

func (c *Client) DetachStoragePolicy(ctx context.Context, scopeId string, version uint32, opt ...Option) (*AttachStoragePolicyResult, error)

DetachStoragePolicy detaches storage policy from the provided scopeId if one is attached.

func (*Client) List 

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

func (*Client) ListKeyVersionDestructionJobs added in v0.0.32 

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

func (*Client) ListKeys added in v0.0.32 

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

func (*Client) ListNextPage added in v0.0.53 

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

func (*Client) Read 

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

func (*Client) RotateKeys added in v0.0.32 

func (c *Client) RotateKeys(ctx context.Context, scopeId string, rewrapKeys bool, opt ...Option) (*KeysRotateResult, error)

func (*Client) Update 

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

type DetachStoragePolicyResult added in v0.0.45 

type DetachStoragePolicyResult = ScopeReadResult

type Key added in v0.0.32 

type Key struct {
	Id          string        `json:"id,omitempty"`
	Scope       *ScopeInfo    `json:"scope,omitempty"`
	Purpose     string        `json:"purpose,omitempty"`
	CreatedTime time.Time     `json:"created_time,omitempty"`
	Type        string        `json:"type,omitempty"`
	Versions    []*KeyVersion `json:"versions,omitempty"`
}

type KeyListResult added in v0.0.32 

type KeyListResult struct {
	Items []*Key
	// contains filtered or unexported fields
}

func (KeyListResult) GetItems added in v0.0.32 

func (n KeyListResult) GetItems() []*Key

func (KeyListResult) GetResponse added in v0.0.32 

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

type KeyVersion added in v0.0.32 

type KeyVersion struct {
	Id          string    `json:"id,omitempty"`
	Version     uint32    `json:"version,omitempty"`
	CreatedTime time.Time `json:"created_time,omitempty"`
}

type KeyVersionDestructionJob added in v0.0.32 

type KeyVersionDestructionJob struct {
	KeyVersionId   string     `json:"key_version_id,omitempty"`
	Scope          *ScopeInfo `json:"scope,omitempty"`
	Status         string     `json:"status,omitempty"`
	CreatedTime    time.Time  `json:"created_time,omitempty"`
	CompletedCount int64      `json:"completed_count,string,omitempty"`
	TotalCount     int64      `json:"total_count,string,omitempty"`
}

type KeyVersionDestructionJobListResult added in v0.0.32 

type KeyVersionDestructionJobListResult struct {
	Items []*KeyVersionDestructionJob
	// contains filtered or unexported fields
}

func (KeyVersionDestructionJobListResult) GetItems added in v0.0.32 

func (n KeyVersionDestructionJobListResult) GetItems() []*KeyVersionDestructionJob

func (KeyVersionDestructionJobListResult) GetResponse added in v0.0.32 

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

type KeyVersionDestructionResult added in v0.0.32 

type KeyVersionDestructionResult struct {
	State string
	// contains filtered or unexported fields
}

func (KeyVersionDestructionResult) GetResponse added in v0.0.32 

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

type KeysRotateResult added in v0.0.32 

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

func (KeysRotateResult) GetResponse added in v0.0.32 

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

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 DefaultPrimaryAuthMethodId added in v0.0.9 

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 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 WithPrimaryAuthMethodId added in v0.0.9 

func WithPrimaryAuthMethodId(inPrimaryAuthMethodId string) Option

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 WithSkipAdminRoleCreation 

func WithSkipAdminRoleCreation(inSkipAdminRoleCreation bool) Option

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.

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"`
	StoragePolicyId             string              `json:"storage_policy_id,omitempty"`
}

type ScopeCreateResult 

type ScopeCreateResult = ScopeReadResult

type ScopeDeleteResult 

type ScopeDeleteResult struct {
	Response *api.Response
}

func (ScopeDeleteResult) GetItem added in v0.0.10 

func (n ScopeDeleteResult) GetItem() any

GetItem will always be nil for ScopeDeleteResult

func (ScopeDeleteResult) GetResponse added in v0.0.7 

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 `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 (ScopeListResult) GetEstItemCount added in v0.0.44 

func (n ScopeListResult) GetEstItemCount() uint

func (ScopeListResult) GetItems 

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

func (ScopeListResult) GetListToken added in v0.0.44 

func (n ScopeListResult) GetListToken() string

func (ScopeListResult) GetRemovedIds added in v0.0.44 

func (n ScopeListResult) GetRemovedIds() []string

func (ScopeListResult) GetResponse added in v0.0.7 

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

func (ScopeListResult) GetResponseType added in v0.0.44 

func (n ScopeListResult) GetResponseType() string

type ScopeReadResult 

type ScopeReadResult struct {
	Item     *Scope
	Response *api.Response
}

func (ScopeReadResult) GetItem 

func (n ScopeReadResult) GetItem() *Scope

func (ScopeReadResult) GetResponse added in v0.0.7 

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

type ScopeUpdateResult 

type ScopeUpdateResult = ScopeReadResult

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.