targets

package
v0.0.6 Latest Latest
Warning

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

Go to latest
Published: Feb 22, 2021 License: MPL-2.0 Imports: 10 Imported by: 4

Documentation

Overview

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

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

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

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

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

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) AddHostSets

func (c *Client) AddHostSets(ctx context.Context, targetId string, version uint32, hostSetIds []string, opt ...Option) (*TargetUpdateResult, error)

func (*Client) ApiClient

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

ApiClient returns the underlying API client

func (*Client) AuthorizeSession

func (c *Client) AuthorizeSession(ctx context.Context, targetId string, opt ...Option) (*SessionAuthorizationResult, error)

func (*Client) Create

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

func (*Client) Delete

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

func (*Client) List

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

func (*Client) Read

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

func (*Client) RemoveHostSets

func (c *Client) RemoveHostSets(ctx context.Context, targetId string, version uint32, hostSetIds []string, opt ...Option) (*TargetUpdateResult, error)

func (*Client) SetHostSets

func (c *Client) SetHostSets(ctx context.Context, targetId string, version uint32, hostSetIds []string, opt ...Option) (*TargetUpdateResult, error)

func (*Client) Update

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

type HostSet

type HostSet struct {
	Id            string `json:"id,omitempty"`
	HostCatalogId string `json:"host_catalog_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 DefaultAttributes

func DefaultAttributes() Option

func DefaultDescription

func DefaultDescription() Option

func DefaultName

func DefaultName() Option

func DefaultSessionConnectionLimit

func DefaultSessionConnectionLimit() Option

func DefaultSessionMaxSeconds

func DefaultSessionMaxSeconds() Option

func DefaultTcpTargetDefaultPort

func DefaultTcpTargetDefaultPort() Option

func DefaultWorkerFilter added in v0.0.4

func DefaultWorkerFilter() Option

func WithAttributes

func WithAttributes(inAttributes map[string]interface{}) 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 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 WithHostId

func WithHostId(inHostId string) Option

func WithName

func WithName(inName 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 WithScopeId added in v0.0.2

func WithScopeId(inScopeId string) Option

func WithScopeName added in v0.0.2

func WithScopeName(inScopeName string) Option

func WithSessionConnectionLimit

func WithSessionConnectionLimit(inSessionConnectionLimit int32) Option

func WithSessionMaxSeconds

func WithSessionMaxSeconds(inSessionMaxSeconds uint32) 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 WithTcpTargetDefaultPort

func WithTcpTargetDefaultPort(inDefaultPort uint32) Option

func WithWorkerFilter added in v0.0.4

func WithWorkerFilter(inWorkerFilter string) Option

type SessionAuthorization

type SessionAuthorization struct {
	SessionId          string            `json:"session_id,omitempty"`
	TargetId           string            `json:"target_id,omitempty"`
	Scope              *scopes.ScopeInfo `json:"scope,omitempty"`
	CreatedTime        time.Time         `json:"created_time,omitempty"`
	UserId             string            `json:"user_id,omitempty"`
	HostSetId          string            `json:"host_set_id,omitempty"`
	HostId             string            `json:"host_id,omitempty"`
	Type               string            `json:"type,omitempty"`
	AuthorizationToken string            `json:"authorization_token,omitempty"`
	Endpoint           string            `json:"endpoint,omitempty"`
}

type SessionAuthorizationResult

type SessionAuthorizationResult struct {
	Item *SessionAuthorization
	// contains filtered or unexported fields
}

func (SessionAuthorizationResult) GetItem

func (n SessionAuthorizationResult) GetItem() interface{}

func (SessionAuthorizationResult) GetResponseBody

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

func (SessionAuthorizationResult) GetResponseMap

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

type Target

type Target 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"`
	Type                   string                 `json:"type,omitempty"`
	HostSetIds             []string               `json:"host_set_ids,omitempty"`
	HostSets               []*HostSet             `json:"host_sets,omitempty"`
	SessionMaxSeconds      uint32                 `json:"session_max_seconds,omitempty"`
	SessionConnectionLimit int32                  `json:"session_connection_limit,omitempty"`
	WorkerFilter           string                 `json:"worker_filter,omitempty"`
	Attributes             map[string]interface{} `json:"attributes,omitempty"`
	AuthorizedActions      []string               `json:"authorized_actions,omitempty"`
	// contains filtered or unexported fields
}

func (Target) ResponseBody

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

func (Target) ResponseMap

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

func (Target) ResponseStatus added in v0.0.3

func (n Target) ResponseStatus() int

type TargetCreateResult

type TargetCreateResult = TargetReadResult

type TargetDeleteResult

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

func (TargetDeleteResult) GetResponseBody

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

func (TargetDeleteResult) GetResponseMap

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

type TargetListResult

type TargetListResult struct {
	Items []*Target
	// contains filtered or unexported fields
}

func (TargetListResult) GetItems

func (n TargetListResult) GetItems() interface{}

func (TargetListResult) GetResponseBody

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

func (TargetListResult) GetResponseMap

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

type TargetReadResult

type TargetReadResult struct {
	Item *Target
	// contains filtered or unexported fields
}

func (TargetReadResult) GetItem

func (n TargetReadResult) GetItem() interface{}

func (TargetReadResult) GetResponseBody

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

func (TargetReadResult) GetResponseMap

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

type TargetUpdateResult

type TargetUpdateResult = TargetReadResult

type TcpTargetAttributes

type TcpTargetAttributes struct {
	DefaultPort uint32 `json:"default_port,omitempty"`
}

type WorkerInfo

type WorkerInfo struct {
	Address string `json:"address,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL