Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type PoliciesQuery ¶
type PoliciesQuery struct {
GitRef string `uri:"gitRef" json:"gitRef"`
PartialName string `uri:"partialName,omitempty" json:"partialName,omitempty"`
Skip int `uri:"skip,omitempty" json:"skip,omitempty"`
Take int `uri:"take,omitempty" json:"take,omitempty"`
}
PoliciesQuery represents query parameters for listing policies.
type PoliciesQueryResult ¶
type PoliciesQueryResult struct {
Policies []Policy
ItemsPerPage int
FilteredItemsCount int
TotalItemsCount int
}
PoliciesQueryResult paginated collection of policies
func List ¶
func List(client newclient.Client, query PoliciesQuery) (*PoliciesQueryResult, error)
List returns a paginated collection of Platform Hub policies based on the provided query.
func (*PoliciesQueryResult) UnmarshalJSON ¶
func (r *PoliciesQueryResult) UnmarshalJSON(data []byte) error
type Policy ¶
type Policy interface {
GetName() string
SetName(string)
GetDescription() string
SetDescription(string)
GetScopeRego() string
SetScopeRego(string)
GetConditionsRego() string
SetConditionsRego(string)
GetViolationAction() string
SetViolationAction(string)
GetViolationReason() string
SetViolationReason(string)
Validate() error
PolicyKey
}
Policy represents a set of information to create new Hub policy.
type PolicyDraft ¶
type PolicyDraft struct {
GitRef string
Slug string
Name string
Description string
ScopeRego string
ConditionsRego string
ViolationAction string
ViolationReason string
}
PolicyDraft represents a set of information to create new Hub policy.
type PublishedPoliciesQuery ¶
type PublishedPoliciesQuery struct {
Slug string `uri:"slug"`
Skip int `uri:"skip,omitempty"`
Take int `uri:"take,omitempty"`
}
PublishedPoliciesQuery query parameters for listing published policy versions.
type PublishedPoliciesQueryResult ¶
type PublishedPoliciesQueryResult struct {
Items []PublishedPolicy
ItemsPerPage int
TotalResults int
}
PublishedPoliciesQueryResult paginated collection of published policy versions
func ListVersions ¶
func ListVersions(client newclient.Client, query PublishedPoliciesQuery) (*PublishedPoliciesQueryResult, error)
ListVersions returns published versions of a Platform Hub policy.
func (*PublishedPoliciesQueryResult) UnmarshalJSON ¶
func (r *PublishedPoliciesQueryResult) UnmarshalJSON(data []byte) error
type PublishedPolicy ¶
type PublishedPolicy interface {
GetID() string
GetPublishedDate() time.Time
GetGitRef() string
GetGitCommit() string
GetName() string
GetDescription() string
GetViolationReason() string
GetViolationAction() string
GetScopeRego() string
GetConditionsRego() string
IsActivated() bool
PublishedPolicyKey
}
PublishedPolicy represents a read-only view of a published Platform Hub policy version.
func ActivateVersion ¶
func ActivateVersion(client newclient.Client, policy PublishedPolicyKey) (PublishedPolicy, error)
ActivateVersion activates a published Platform Hub policy version.
func DeactivateVersion ¶
func DeactivateVersion(client newclient.Client, policy PublishedPolicyKey) (PublishedPolicy, error)
DeactivateVersion deactivates a published Platform Hub policy version.