Documentation ¶
Index ¶
- Variables
- func BoolPointer(b bool) *bool
- func PrettyPrint(title string, incoming interface{})
- type Client
- func (c *Client) CreateFact(factNew FactJson, options *FactListOptions) (fact FactJson, statusCode int, Error error)
- func (c *Client) CreateFactEncode(factNew Fact, options *FactListOptions) (fact Fact, statusCode int, Error error)
- func (c *Client) CreateGroup(groupNew GroupJson, options *GroupListOptions) (group GroupJson, statusCode int, Error error)
- func (c *Client) CreateGroupEncode(groupNew Group, options *GroupListOptions) (group Group, statusCode int, Error error)
- func (c *Client) CreateHost(hostNew HostJson, options *HostListOptions) (host HostJson, statusCode int, Error error)
- func (c *Client) CreateHostEncode(hostNew Host, options *HostListOptions) (host Host, statusCode int, Error error)
- func (c *Client) CreateLink(linkNew LinkCreateRequest, options *LinkListOptions) (link Link, statusCode int, Error error)
- func (c *Client) CreateProfile(profileNew ProfileCreateRequest, options *ProfileListOptions) (profile Profile, statusCode int, Error error)
- func (c *Client) CreateRuleset(rulesetNew RulesetCreateRequest, options *RulesetListOptions) (ruleset Ruleset, statusCode int, Error error)
- func (c *Client) CreateService(serviceNew ServiceCreateRequest, options *ServiceListOptions) (service Service, statusCode int, Error error)
- func (c *Client) CreateZone(zoneNew ZoneCreateRequest, options *ZoneListOptions) (zone Zone, statusCode int, Error error)
- func (c *Client) DeleteFact(FactID string, options *FactListOptions) (fact Fact, statusCode int, Error error)
- func (c *Client) DeleteGroup(GroupID string, options *GroupListOptions) (group Group, statusCode int, Error error)
- func (c *Client) DeleteHost(hostID string, options *HostListOptions) (host Host, statusCode int, Error error)
- func (c *Client) DeleteLink(LinkID string, options *LinkListOptions) (link Link, statusCode int, Error error)
- func (c *Client) DeleteProfile(ProfileID string, options *ProfileListOptions) (profile Profile, statusCode int, Error error)
- func (c *Client) DeleteRuleset(rulesetId string, options *RulesetListOptions) (ruleset Ruleset, statusCode int, Error error)
- func (c *Client) DeleteService(ServiceID string, options *ServiceListOptions) (service Service, statusCode int, Error error)
- func (c *Client) DeleteZone(ZoneID string, options *ZoneListOptions) (zone Zone, statusCode int, Error error)
- func (c *Client) GetExternal(ExternalID string, options *ExternalListOptions) (external External, statusCode int, Error error)
- func (c *Client) GetExternals(options *ExternalListOptions) (externalList ExternalList, statusCode int, Error error)
- func (c *Client) GetFact(FactID string, options *FactListOptions) (fact FactJson, statusCode int, Error error)
- func (c *Client) GetFactByName(FactName string, options *FactListOptions) (fact FactJson, statusCode int, Error error)
- func (c *Client) GetFactByNameEncode(FactName string, options *FactListOptions) (fact Fact, statusCode int, Error error)
- func (c *Client) GetFactEncode(FactID string, options *FactListOptions) (fact Fact, statusCode int, Error error)
- func (c *Client) GetFacts(options *FactsListOptions) (factsList FactsListJson, statusCode int, Error error)
- func (c *Client) GetFactsEncode(options *FactsListOptions) (factsList FactsList, statusCode int, Error error)
- func (c *Client) GetGroup(GroupID string, options *GroupListOptions) (group GroupJson, statusCode int, Error error)
- func (c *Client) GetGroupEncode(GroupID string, options *GroupListOptions) (group Group, statusCode int, Error error)
- func (c *Client) GetGroups(options *GroupsListOptions) (groupsList GroupsListJson, statusCode int, Error error)
- func (c *Client) GetGroupsEncode(options *GroupsListOptions) (groupsList GroupsList, statusCode int, Error error)
- func (c *Client) GetHost(hostID string, options *HostListOptions) (host HostJson, statusCode int, Error error)
- func (c *Client) GetHostEncode(hostID string, options *HostListOptions) (host Host, statusCode int, Error error)
- func (c *Client) GetHosts(options *HostsListOptions) (hostsList HostsListJson, statusCode int, Error error)
- func (c *Client) GetHostsEncode(options *HostsListOptions) (hostsList HostsList, statusCode int, Error error)
- func (c *Client) GetLink(LinkID string, options *LinkListOptions) (link Link, statusCode int, Error error)
- func (c *Client) GetLinks(options *LinksListOptions) (linksList LinksList, statusCode int, Error error)
- func (c *Client) GetProfile(ProfileID string, options *ProfileListOptions) (profile Profile, statusCode int, Error error)
- func (c *Client) GetProfiles(options *ProfilesListOptions) (profilesList ProfilesList, statusCode int, Error error)
- func (c *Client) GetRuleset(rulesetId string, options *RulesetListOptions) (ruleset Ruleset, statusCode int, Error error)
- func (c *Client) GetRulesetByName(rulesetName string, options *RulesetListOptions) (ruleset Ruleset, statusCode int, Error error)
- func (c *Client) GetRulesets(options *RulesetsListOptions) (rulesetList RulesetsList, statusCode int, Error error)
- func (c *Client) GetService(ServiceID string, options *ServiceListOptions) (service Service, statusCode int, Error error)
- func (c *Client) GetServices(options *ServicesListOptions) (servicesList ServicesList, statusCode int, Error error)
- func (c *Client) GetZone(ZoneID string, options *ZoneListOptions) (zone Zone, statusCode int, Error error)
- func (c *Client) GetZoneByName(ZoneName string, options *ZoneListOptions) (zone Zone, statusCode int, Error error)
- func (c *Client) GetZones(options *ZonesListOptions) (zonesList ZonesList, statusCode int, Error error)
- func (c *Client) UpdateFact(FactID string, FactUpdate FactJson, options *FactListOptions) (fact FactJson, statusCode int, Error error)
- func (c *Client) UpdateFactEncode(FactID string, factUpdate Fact, options *FactListOptions) (fact Fact, statusCode int, Error error)
- func (c *Client) UpdateGroup(GroupID string, GroupUpdate GroupJson, options *GroupListOptions) (group GroupJson, statusCode int, Error error)
- func (c *Client) UpdateGroupEncode(GroupID string, groupUpdate Group, options *GroupListOptions) (group Group, statusCode int, Error error)
- func (c *Client) UpdateHost(hostID string, hostUpdate HostJson, options *HostListOptions) (host HostJson, statusCode int, Error error)
- func (c *Client) UpdateHostEncode(hostID string, hostUpdate Host, options *HostListOptions) (host Host, statusCode int, Error error)
- func (c *Client) UpdateLink(LinkID string, LinkUpdate LinkUpdateRequest, options *LinkListOptions) (link Link, statusCode int, Error error)
- func (c *Client) UpdateProfile(ProfileID string, ProfileUpdate ProfileUpdateRequest, ...) (profile Profile, statusCode int, Error error)
- func (c *Client) UpdateRuleset(rulesetId string, rulesetUpdate RulesetUpdateRequest, ...) (ruleset Ruleset, statusCode int, Error error)
- func (c *Client) UpdateService(ServiceID string, ServiceUpdate ServiceUpdateRequest, ...) (service Service, statusCode int, Error error)
- func (c *Client) UpdateZone(ZoneID string, ZoneUpdate ZoneUpdateRequest, options *ZoneListOptions) (zone Zone, statusCode int, Error error)
- type Connection
- type Ec2SecurityGroupIds
- type External
- type ExternalList
- type ExternalListOptions
- type Fact
- type FactCreateRequest
- type FactCreateResponse
- type FactGroup
- type FactGroupJson
- type FactJson
- type FactListOptions
- type FactUpdateRequest
- type FactsList
- type FactsListJson
- type FactsListOptions
- type Group
- type GroupCreateRequest
- type GroupCreateResponse
- type GroupJson
- type GroupListOptions
- type GroupUpdateRequest
- type GroupsList
- type GroupsListJson
- type GroupsListOptions
- type Host
- type HostCreateRequest
- type HostCreateResponse
- type HostJson
- type HostListOptions
- type HostUpdateRequest
- type HostsList
- type HostsListJson
- type HostsListOptions
- type Link
- type LinkCreateRequest
- type LinkCreateResponse
- type LinkListOptions
- type LinkUpdateRequest
- type LinksList
- type LinksListOptions
- type PortProtocol
- type Profile
- type ProfileCreateRequest
- type ProfileCreateResponse
- type ProfileListOptions
- type ProfileUpdateRequest
- type ProfilesList
- type ProfilesListOptions
- type Rule
- type Rules
- type Ruleset
- type RulesetCreateRequest
- type RulesetListOptions
- type RulesetUpdateRequest
- type RulesetsList
- type RulesetsListOptions
- type SSLOptions
- type Service
- type ServiceCreateRequest
- type ServiceCreateResponse
- type ServiceListOptions
- type ServiceUpdateRequest
- type ServicesList
- type ServicesListOptions
- type V4
- type V6
- type Zone
- type ZoneCreateRequest
- type ZoneCreateResponse
- type ZoneListOptions
- type ZoneUpdateRequest
- type ZonesList
- type ZonesListOptions
Constants ¶
This section is empty.
Variables ¶
View Source
var Commit string
Functions ¶
func BoolPointer ¶ added in v1.0.3
func PrettyPrint ¶
func PrettyPrint(title string, incoming interface{})
Types ¶
type Client ¶
type Client struct {
*resty.Client
}
func (*Client) CreateFact ¶
func (*Client) CreateFactEncode ¶
func (*Client) CreateGroup ¶
func (*Client) CreateGroupEncode ¶
func (*Client) CreateHost ¶
func (*Client) CreateHostEncode ¶
func (*Client) CreateLink ¶
func (c *Client) CreateLink(linkNew LinkCreateRequest, options *LinkListOptions) (link Link, statusCode int, Error error)
func (*Client) CreateProfile ¶
func (c *Client) CreateProfile(profileNew ProfileCreateRequest, options *ProfileListOptions) (profile Profile, statusCode int, Error error)
func (*Client) CreateRuleset ¶
func (c *Client) CreateRuleset(rulesetNew RulesetCreateRequest, options *RulesetListOptions) (ruleset Ruleset, statusCode int, Error error)
func (*Client) CreateService ¶
func (c *Client) CreateService(serviceNew ServiceCreateRequest, options *ServiceListOptions) (service Service, statusCode int, Error error)
func (*Client) CreateZone ¶
func (c *Client) CreateZone(zoneNew ZoneCreateRequest, options *ZoneListOptions) (zone Zone, statusCode int, Error error)
func (*Client) DeleteFact ¶
func (*Client) DeleteGroup ¶
func (*Client) DeleteHost ¶
func (*Client) DeleteLink ¶
func (*Client) DeleteProfile ¶
func (*Client) DeleteRuleset ¶
func (*Client) DeleteService ¶
func (*Client) DeleteZone ¶
func (*Client) GetExternal ¶
func (*Client) GetExternals ¶
func (c *Client) GetExternals(options *ExternalListOptions) (externalList ExternalList, statusCode int, Error error)
func (*Client) GetFactByName ¶
func (*Client) GetFactByNameEncode ¶
func (*Client) GetFactEncode ¶
func (*Client) GetFacts ¶
func (c *Client) GetFacts(options *FactsListOptions) (factsList FactsListJson, statusCode int, Error error)
func (*Client) GetFactsEncode ¶
func (c *Client) GetFactsEncode(options *FactsListOptions) (factsList FactsList, statusCode int, Error error)
func (*Client) GetGroupEncode ¶
func (*Client) GetGroups ¶
func (c *Client) GetGroups(options *GroupsListOptions) (groupsList GroupsListJson, statusCode int, Error error)
func (*Client) GetGroupsEncode ¶
func (c *Client) GetGroupsEncode(options *GroupsListOptions) (groupsList GroupsList, statusCode int, Error error)
func (*Client) GetHostEncode ¶
func (*Client) GetHosts ¶
func (c *Client) GetHosts(options *HostsListOptions) (hostsList HostsListJson, statusCode int, Error error)
func (*Client) GetHostsEncode ¶
func (c *Client) GetHostsEncode(options *HostsListOptions) (hostsList HostsList, statusCode int, Error error)
func (*Client) GetLinks ¶
func (c *Client) GetLinks(options *LinksListOptions) (linksList LinksList, statusCode int, Error error)
func (*Client) GetProfile ¶
func (*Client) GetProfiles ¶
func (c *Client) GetProfiles(options *ProfilesListOptions) (profilesList ProfilesList, statusCode int, Error error)
func (*Client) GetRuleset ¶
func (*Client) GetRulesetByName ¶
func (*Client) GetRulesets ¶
func (c *Client) GetRulesets(options *RulesetsListOptions) (rulesetList RulesetsList, statusCode int, Error error)
func (*Client) GetService ¶
func (*Client) GetServices ¶
func (c *Client) GetServices(options *ServicesListOptions) (servicesList ServicesList, statusCode int, Error error)
func (*Client) GetZoneByName ¶
func (*Client) GetZones ¶
func (c *Client) GetZones(options *ZonesListOptions) (zonesList ZonesList, statusCode int, Error error)
func (*Client) UpdateFact ¶
func (*Client) UpdateFactEncode ¶
func (*Client) UpdateGroup ¶
func (*Client) UpdateGroupEncode ¶
func (*Client) UpdateHost ¶
func (*Client) UpdateHostEncode ¶
func (*Client) UpdateLink ¶
func (c *Client) UpdateLink(LinkID string, LinkUpdate LinkUpdateRequest, options *LinkListOptions) (link Link, statusCode int, Error error)
func (*Client) UpdateProfile ¶
func (c *Client) UpdateProfile(ProfileID string, ProfileUpdate ProfileUpdateRequest, options *ProfileListOptions) (profile Profile, statusCode int, Error error)
func (*Client) UpdateRuleset ¶
func (c *Client) UpdateRuleset(rulesetId string, rulesetUpdate RulesetUpdateRequest, options *RulesetListOptions) (ruleset Ruleset, statusCode int, Error error)
func (*Client) UpdateService ¶
func (c *Client) UpdateService(ServiceID string, ServiceUpdate ServiceUpdateRequest, options *ServiceListOptions) (service Service, statusCode int, Error error)
func (*Client) UpdateZone ¶
func (c *Client) UpdateZone(ZoneID string, ZoneUpdate ZoneUpdateRequest, options *ZoneListOptions) (zone Zone, statusCode int, Error error)
type Connection ¶
type Ec2SecurityGroupIds ¶
type ExternalList ¶
type ExternalList []External
type ExternalListOptions ¶
type Fact ¶
type Fact struct { ID string `json:"id"` Name string `json:"name"` Groups map[string]*FactGroup `json:"groups"` }
func EncodeFact ¶ added in v1.0.2
type FactCreateRequest ¶
type FactCreateResponse ¶
type FactGroupJson ¶
type FactJson ¶
type FactJson struct { ID string `json:"id,omitempty"` Name string `json:"name"` Groups map[string]*FactGroupJson `json:"groups"` }
func DecodeFact ¶ added in v1.0.2
type FactListOptions ¶
type FactUpdateRequest ¶
type FactUpdateRequest struct { Name string `json:"name"` Groups map[string]*FactGroup `json:"groups"` }
FactUpdateRequest is a struct for the request object required to update an Fact
type FactsListJson ¶
type FactsListJson []FactJson
type FactsListOptions ¶
type Group ¶
type Group struct { ID string `json:"id"` Description string `json:"description"` Name string `json:"name"` ProfileId string `json:"profile_id"` ProfileName string `json:"profile_name"` ProfileVersion string `json:"profile_version"` Ec2SecurityGroupIds []*Ec2SecurityGroupIds `json:"ec2_security_group_ids"` Vars string `json:"vars"` AlertEnable *bool `json:"alert_enable,omitempty"` }
type GroupCreateRequest ¶
type GroupCreateRequest struct { Description string `json:"description,omitempty"` Name string `json:"name"` ProfileId string `json:"profile_id,omitempty"` ProfileName string `json:"profile_name,omitempty"` ProfileVersion string `json:"profile_version,omitempty"` Ec2SecurityGroupIds []*Ec2SecurityGroupIds `json:"ec2_security_group_ids"` Vars string `json:"vars"` AlertEnable *bool `json:"alert_enable,omitempty"` }
type GroupCreateResponse ¶
type GroupJson ¶
type GroupJson struct { ID string `json:"id,omitempty"` Description string `json:"description,omitempty"` Name string `json:"name,omitempty"` ProfileId string `json:"profile_id,omitempty"` ProfileName string `json:"profile_name,omitempty"` ProfileVersion string `json:"profile_version,omitempty"` Ec2SecurityGroupIds []*Ec2SecurityGroupIds `json:"ec2_security_group_ids,omitempty"` Vars map[string]any `json:"vars,omitempty"` //parsed json AlertEnable *bool `json:"alert_enable,omitempty"` }
type GroupListOptions ¶
type GroupUpdateRequest ¶
type GroupUpdateRequest struct { Description string `json:"description,omitempty"` Name string `json:"name,omitempty"` ProfileId string `json:"profile_id,omitempty"` ProfileName string `json:"profile_name,omitempty"` ProfileVersion string `json:"profile_version,omitempty"` Ec2SecurityGroupIds []*Ec2SecurityGroupIds `json:"ec2_security_group_ids"` Vars string `json:"vars,omitempty"` AlertEnable *bool `json:"alert_enable,omitempty"` }
GroupUpdateRequest is a struct for the request object required to update a Group
type GroupsList ¶
type GroupsList []Group
type GroupsListJson ¶
type GroupsListJson []GroupJson
type GroupsListOptions ¶
type Host ¶
type Host struct { Environment string `json:"environment"` Group string `json:"group"` ID string `json:"id"` HostKey string `json:"hostkey"` Location string `json:"location"` Name string `json:"name"` Vars string `json:"vars"` //raw json for Terraform AlertEnable *bool `json:"alert_enable,omitempty"` }
type HostCreateRequest ¶
type HostCreateResponse ¶
type HostJson ¶
type HostJson struct { Environment string `json:"environment,omitempty"` Group string `json:"group,omitempty"` ID string `json:"id,omitempty"` HostKey string `json:"hostkey,omitempty"` Location string `json:"location,omitempty"` Name string `json:"name,omitempty"` Vars map[string]any `json:"vars,omitempty"` //parsed json AlertEnable *bool `json:"alert_enable,omitempty"` }
type HostListOptions ¶
type HostUpdateRequest ¶
type HostUpdateRequest struct { Environment string `json:"environment,omitempty"` Group string `json:"group,omitempty"` ID string `json:"id,omitempty"` HostKey string `json:"hostkey,omitempty"` Location string `json:"location,omitempty"` Name string `json:"name,omitempty"` Vars string `json:"vars,omitempty"` AlertEnable *bool `json:"alert_enable,omitempty"` }
HostUpdateRequest is a struct for the request object required to update a Host
type HostsListJson ¶
type HostsListJson []HostJson
type HostsListOptions ¶
type LinkCreateRequest ¶
type LinkCreateResponse ¶
type LinkListOptions ¶
type LinkUpdateRequest ¶
type LinkUpdateRequest struct { AddressHandling string `json:"address_handling"` Connection *Connection `json:"connection"` ConnectionType string `json:"connection_type"` Direction string `json:"direction"` Enabled bool `json:"enabled"` Name string `json:"name"` }
LinkUpdateRequest is a struct for the request object required to update a Link
type LinksListOptions ¶
type PortProtocol ¶
type ProfileCreateRequest ¶
type ProfileCreateResponse ¶
type ProfileListOptions ¶
type ProfileUpdateRequest ¶
type ProfileUpdateRequest struct { Name string `json:"name,omitempty"` Version string `json:"version,omitempty"` }
ProfileUpdateRequest is a struct for the request object required to update a Profile
type ProfilesList ¶
type ProfilesList []Profile
type ProfilesListOptions ¶
type Rule ¶
type Rule struct { Action string `json:"action"` Active bool `json:"active"` Comment string `json:"comment"` Environments []string `json:"environments"` Group string `json:"group"` GroupType string `json:"group_type"` Interface string `json:"interface"` Log bool `json:"log"` LogPrefix string `json:"log_prefix"` Order int `json:"order"` Service string `json:"service"` States []string `json:"states"` Type string `json:"type"` }
type RulesetCreateRequest ¶
type RulesetListOptions ¶
type RulesetUpdateRequest ¶
type RulesetsList ¶
type RulesetsList []Ruleset
type RulesetsListOptions ¶
type SSLOptions ¶
type Service ¶
type Service struct { ID string `json:"id"` Services []*PortProtocol `json:"services"` Name string `json:"name"` Version int `json:"version"` }
type ServiceCreateRequest ¶
type ServiceCreateRequest struct { Services []*PortProtocol `json:"services"` Name string `json:"name"` Version int `json:"version"` }
type ServiceCreateResponse ¶
type ServiceListOptions ¶
type ServiceUpdateRequest ¶
type ServiceUpdateRequest struct { Services []*PortProtocol `json:"services"` Name string `json:"name"` Version int `json:"version"` }
type ServicesList ¶
type ServicesList []Service
type ServicesListOptions ¶
type ZoneCreateRequest ¶
type ZoneCreateResponse ¶
type ZoneListOptions ¶
type ZoneUpdateRequest ¶
type ZoneUpdateRequest struct { IPv4Addresses []string `json:"ipv4_addresses"` IPv6Addresses []string `json:"ipv6_addresses"` Name string `json:"name"` }
ZoneUpdateRequest is a struct for the request object required to update a Zone
type ZonesListOptions ¶
Click to show internal directories.
Click to hide internal directories.