views

package
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: May 20, 2020 License: MIT Imports: 1 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// IncidentMap is a map of attribute names in result type Incident indexed by
	// view name.
	IncidentMap = map[string][]string{
		"default": []string{
			"id",
			"incident_aggregate_id",
			"project",
			"href",
			"applied_policy",
			"summary",
			"created_at",
			"updated_at",
			"resolved_at",
			"resolved_by",
			"resolution_message",
			"state",
			"violation_data_count",
			"severity",
			"category",
			"options",
			"dry_run",
			"action_failed",
			"kind",
			"etag",
			"not_modified",
		},
		"extended": []string{
			"id",
			"incident_aggregate_id",
			"project",
			"href",
			"applied_policy",
			"summary",
			"detail",
			"created_at",
			"updated_at",
			"resolved_at",
			"resolved_by",
			"resolution_message",
			"state",
			"violation_data_count",
			"severity",
			"category",
			"options",
			"dry_run",
			"action_failed",
			"kind",
			"etag",
			"not_modified",
		},
		"source": []string{
			"id",
			"incident_aggregate_id",
			"project",
			"href",
			"applied_policy",
			"kind",
			"etag",
			"not_modified",
		},
	}
	// IncidentListMap is a map of attribute names in result type IncidentList
	// indexed by view name.
	IncidentListMap = map[string][]string{
		"default": []string{
			"count",
			"items",
			"etag",
			"not_modified",
			"kind",
		},
		"extended": []string{
			"count",
			"items",
			"etag",
			"not_modified",
			"kind",
		},
	}
	// EscalationsMap is a map of attribute names in result type Escalations
	// indexed by view name.
	EscalationsMap = map[string][]string{
		"default": []string{
			"status",
			"escalations",
			"started_at",
			"finished_at",
		},
	}
	// ResolutionsMap is a map of attribute names in result type Resolutions
	// indexed by view name.
	ResolutionsMap = map[string][]string{
		"default": []string{
			"status",
			"resolutions",
			"started_at",
			"finished_at",
		},
	}
	// AppliedPolicyMap is a map of attribute names in result type AppliedPolicy
	// indexed by view name.
	AppliedPolicyMap = map[string][]string{
		"default": []string{
			"id",
			"policy_aggregate_id",
			"incident_aggregate_id",
			"name",
			"project",
			"href",
			"policy_template",
			"published_template",
			"description",
			"doc_link",
			"info",
			"created_by",
			"created_at",
			"updated_at",
			"severity",
			"category",
			"frequency",
			"dry_run",
			"skip_approvals",
			"options",
			"credentials",
			"status",
			"error",
			"errored_at",
			"scope",
			"kind",
		},
		"source": []string{
			"id",
			"policy_aggregate_id",
			"incident_aggregate_id",
			"name",
			"project",
			"href",
			"policy_template",
			"published_template",
			"kind",
		},
		"link": []string{
			"id",
			"policy_aggregate_id",
			"incident_aggregate_id",
			"name",
			"href",
			"policy_template",
			"published_template",
			"created_by",
			"created_at",
			"frequency",
			"kind",
		},
	}
	// PolicyTemplateMap is a map of attribute names in result type PolicyTemplate
	// indexed by view name.
	PolicyTemplateMap = map[string][]string{
		"default": []string{
			"id",
			"name",
			"project_id",
			"rs_pt_ver",
			"short_description",
			"doc_link",
			"info",
			"default_frequency",
			"href",
			"fingerprint",
			"category",
			"created_by",
			"created_at",
			"updated_by",
			"updated_at",
			"required_roles",
			"severity",
			"tenancy",
			"kind",
		},
		"extended": []string{
			"id",
			"name",
			"project_id",
			"rs_pt_ver",
			"short_description",
			"long_description",
			"doc_link",
			"info",
			"default_frequency",
			"href",
			"fingerprint",
			"category",
			"created_by",
			"created_at",
			"updated_by",
			"updated_at",
			"permissions",
			"required_roles",
			"parameters",
			"severity",
			"tenancy",
			"credentials",
			"kind",
		},
		"source": []string{
			"id",
			"name",
			"href",
			"filename",
			"source",
			"fingerprint",
			"kind",
		},
		"link": []string{
			"id",
			"name",
			"href",
			"fingerprint",
			"updated_at",
			"updated_by",
			"kind",
		},
	}
	// PublishedTemplateMap is a map of attribute names in result type
	// PublishedTemplate indexed by view name.
	PublishedTemplateMap = map[string][]string{
		"default": []string{
			"id",
			"name",
			"org_id",
			"project_id",
			"policy_template_id",
			"policy_template_url",
			"policy_template_fingerprint",
			"rs_pt_ver",
			"short_description",
			"doc_link",
			"info",
			"default_frequency",
			"href",
			"fingerprint",
			"category",
			"created_by",
			"created_at",
			"updated_by",
			"updated_at",
			"hidden_by",
			"hidden_at",
			"required_roles",
			"severity",
			"built_in",
			"hidden",
			"tenancy",
			"kind",
		},
		"extended": []string{
			"id",
			"name",
			"org_id",
			"project_id",
			"policy_template_id",
			"policy_template_url",
			"policy_template_fingerprint",
			"rs_pt_ver",
			"short_description",
			"long_description",
			"doc_link",
			"info",
			"default_frequency",
			"href",
			"fingerprint",
			"category",
			"created_by",
			"created_at",
			"updated_by",
			"updated_at",
			"hidden_by",
			"hidden_at",
			"permissions",
			"required_roles",
			"parameters",
			"severity",
			"built_in",
			"hidden",
			"tenancy",
			"credentials",
			"kind",
		},
		"source": []string{
			"id",
			"name",
			"href",
			"filename",
			"source",
			"fingerprint",
			"kind",
		},
		"link": []string{
			"id",
			"name",
			"href",
			"fingerprint",
			"updated_at",
			"updated_by",
			"built_in",
			"kind",
		},
	}
	// IncidentCollectionMap is a map of attribute names in result type
	// IncidentCollection indexed by view name.
	IncidentCollectionMap = map[string][]string{
		"default": []string{
			"id",
			"incident_aggregate_id",
			"project",
			"href",
			"applied_policy",
			"summary",
			"created_at",
			"updated_at",
			"resolved_at",
			"resolved_by",
			"resolution_message",
			"state",
			"violation_data_count",
			"severity",
			"category",
			"options",
			"dry_run",
			"action_failed",
			"kind",
			"etag",
			"not_modified",
		},
		"extended": []string{
			"id",
			"incident_aggregate_id",
			"project",
			"href",
			"applied_policy",
			"summary",
			"detail",
			"created_at",
			"updated_at",
			"resolved_at",
			"resolved_by",
			"resolution_message",
			"state",
			"violation_data_count",
			"severity",
			"category",
			"options",
			"dry_run",
			"action_failed",
			"kind",
			"etag",
			"not_modified",
		},
		"source": []string{
			"id",
			"incident_aggregate_id",
			"project",
			"href",
			"applied_policy",
			"kind",
			"etag",
			"not_modified",
		},
	}
	// EscalationMap is a map of attribute names in result type Escalation indexed
	// by view name.
	EscalationMap = map[string][]string{
		"default": []string{
			"status",
			"name",
			"actions",
		},
	}
	// EscalationActionMap is a map of attribute names in result type
	// EscalationAction indexed by view name.
	EscalationActionMap = map[string][]string{
		"default": []string{
			"type",
			"status",
			"started_at",
			"finished_at",
			"error",
			"approval_request",
			"process_href",
		},
	}
	// ApprovalRequestMap is a map of attribute names in result type
	// ApprovalRequest indexed by view name.
	ApprovalRequestMap = map[string][]string{
		"default": []string{
			"id",
			"project_id",
			"href",
			"label",
			"description",
			"subject",
			"created_at",
			"updated_at",
			"status",
			"kind",
		},
		"extended": []string{
			"id",
			"project_id",
			"href",
			"label",
			"description",
			"subject",
			"created_at",
			"updated_at",
			"status",
			"parameters",
			"options",
			"approved_by",
			"approved_at",
			"denial_comment",
			"denied_by",
			"denied_at",
			"kind",
		},
	}
	// ResolutionMap is a map of attribute names in result type Resolution indexed
	// by view name.
	ResolutionMap = map[string][]string{
		"default": []string{
			"status",
			"name",
			"actions",
		},
	}
	// ResolutionActionMap is a map of attribute names in result type
	// ResolutionAction indexed by view name.
	ResolutionActionMap = map[string][]string{
		"default": []string{
			"type",
			"status",
			"started_at",
			"finished_at",
			"error",
			"approval_request",
			"process_href",
		},
	}
)

Functions

func ValidateAppliedPolicyView added in v1.0.6 

func ValidateAppliedPolicyView(result *AppliedPolicyView) (err error)

ValidateAppliedPolicyView runs the validations defined on AppliedPolicyView using the "default" view. 

func ValidateAppliedPolicyViewLink(result *AppliedPolicyView) (err error)

ValidateAppliedPolicyViewLink runs the validations defined on AppliedPolicyView using the "link" view.

func ValidateAppliedPolicyViewSource added in v1.0.6 

func ValidateAppliedPolicyViewSource(result *AppliedPolicyView) (err error)

ValidateAppliedPolicyViewSource runs the validations defined on AppliedPolicyView using the "source" view.

func ValidateApprovalRequestView added in v1.0.6 

func ValidateApprovalRequestView(result *ApprovalRequestView) (err error)

ValidateApprovalRequestView runs the validations defined on ApprovalRequestView using the "default" view.

func ValidateApprovalRequestViewExtended added in v1.0.6 

func ValidateApprovalRequestViewExtended(result *ApprovalRequestView) (err error)

ValidateApprovalRequestViewExtended runs the validations defined on ApprovalRequestView using the "extended" view.

func ValidateApprovalSubject added in v1.0.6 

func ValidateApprovalSubject(result *ApprovalSubject) (err error)

ValidateApprovalSubject runs the validations defined on ApprovalSubject.

func ValidateConfigurationOptionView added in v1.0.6 

func ValidateConfigurationOptionView(result *ConfigurationOptionView) (err error)

ValidateConfigurationOptionView runs the validations defined on ConfigurationOptionView.

func ValidateCredentialsTagView added in v1.0.6 

func ValidateCredentialsTagView(result *CredentialsTagView) (err error)

ValidateCredentialsTagView runs the validations defined on CredentialsTagView.

func ValidateCredentialsView added in v1.0.6 

func ValidateCredentialsView(result *CredentialsView) (err error)

ValidateCredentialsView runs the validations defined on CredentialsView.

func ValidateEscalationActionView added in v1.0.6 

func ValidateEscalationActionView(result *EscalationActionView) (err error)

ValidateEscalationActionView runs the validations defined on EscalationActionView using the "default" view.

func ValidateEscalationView added in v1.0.6 

func ValidateEscalationView(result *EscalationView) (err error)

ValidateEscalationView runs the validations defined on EscalationView using the "default" view.

func ValidateEscalations added in v1.0.6 

func ValidateEscalations(result *Escalations) (err error)

ValidateEscalations runs the validations defined on the viewed result type Escalations.

func ValidateEscalationsView added in v1.0.6 

func ValidateEscalationsView(result *EscalationsView) (err error)

ValidateEscalationsView runs the validations defined on EscalationsView using the "default" view.

func ValidateIncident added in v1.0.6 

func ValidateIncident(result *Incident) (err error)

ValidateIncident runs the validations defined on the viewed result type Incident.

func ValidateIncidentCollectionView added in v1.0.6 

func ValidateIncidentCollectionView(result IncidentCollectionView) (err error)

ValidateIncidentCollectionView runs the validations defined on IncidentCollectionView using the "default" view.

func ValidateIncidentCollectionViewExtended added in v1.0.6 

func ValidateIncidentCollectionViewExtended(result IncidentCollectionView) (err error)

ValidateIncidentCollectionViewExtended runs the validations defined on IncidentCollectionView using the "extended" view.

func ValidateIncidentCollectionViewSource added in v1.0.6 

func ValidateIncidentCollectionViewSource(result IncidentCollectionView) (err error)

ValidateIncidentCollectionViewSource runs the validations defined on IncidentCollectionView using the "source" view.

func ValidateIncidentList added in v1.0.6 

func ValidateIncidentList(result *IncidentList) (err error)

ValidateIncidentList runs the validations defined on the viewed result type IncidentList.

func ValidateIncidentListView added in v1.0.6 

func ValidateIncidentListView(result *IncidentListView) (err error)

ValidateIncidentListView runs the validations defined on IncidentListView using the "default" view.

func ValidateIncidentListViewExtended added in v1.0.6 

func ValidateIncidentListViewExtended(result *IncidentListView) (err error)

ValidateIncidentListViewExtended runs the validations defined on IncidentListView using the "extended" view.

func ValidateIncidentView added in v1.0.6 

func ValidateIncidentView(result *IncidentView) (err error)

ValidateIncidentView runs the validations defined on IncidentView using the "default" view.

func ValidateIncidentViewExtended added in v1.0.6 

func ValidateIncidentViewExtended(result *IncidentView) (err error)

ValidateIncidentViewExtended runs the validations defined on IncidentView using the "extended" view.

func ValidateIncidentViewSource added in v1.0.6 

func ValidateIncidentViewSource(result *IncidentView) (err error)

ValidateIncidentViewSource runs the validations defined on IncidentView using the "source" view.

func ValidateParameterView added in v1.0.6 

func ValidateParameterView(result *ParameterView) (err error)

ValidateParameterView runs the validations defined on ParameterView.

func ValidatePermissionView added in v1.0.6 

func ValidatePermissionView(result *PermissionView) (err error)

ValidatePermissionView runs the validations defined on PermissionView.

func ValidatePolicyTemplateView added in v1.0.6 

func ValidatePolicyTemplateView(result *PolicyTemplateView) (err error)

ValidatePolicyTemplateView runs the validations defined on PolicyTemplateView using the "default" view.

func ValidatePolicyTemplateViewExtended added in v1.0.6 

func ValidatePolicyTemplateViewExtended(result *PolicyTemplateView) (err error)

ValidatePolicyTemplateViewExtended runs the validations defined on PolicyTemplateView using the "extended" view. 

func ValidatePolicyTemplateViewLink(result *PolicyTemplateView) (err error)

ValidatePolicyTemplateViewLink runs the validations defined on PolicyTemplateView using the "link" view.

func ValidatePolicyTemplateViewSource added in v1.0.6 

func ValidatePolicyTemplateViewSource(result *PolicyTemplateView) (err error)

ValidatePolicyTemplateViewSource runs the validations defined on PolicyTemplateView using the "source" view.

func ValidateProjectView added in v1.0.6 

func ValidateProjectView(result *ProjectView) (err error)

ValidateProjectView runs the validations defined on ProjectView.

func ValidatePublishedTemplateView added in v1.0.6 

func ValidatePublishedTemplateView(result *PublishedTemplateView) (err error)

ValidatePublishedTemplateView runs the validations defined on PublishedTemplateView using the "default" view.

func ValidatePublishedTemplateViewExtended added in v1.0.6 

func ValidatePublishedTemplateViewExtended(result *PublishedTemplateView) (err error)

ValidatePublishedTemplateViewExtended runs the validations defined on PublishedTemplateView using the "extended" view. 

func ValidatePublishedTemplateViewLink(result *PublishedTemplateView) (err error)

ValidatePublishedTemplateViewLink runs the validations defined on PublishedTemplateView using the "link" view.

func ValidatePublishedTemplateViewSource added in v1.0.6 

func ValidatePublishedTemplateViewSource(result *PublishedTemplateView) (err error)

ValidatePublishedTemplateViewSource runs the validations defined on PublishedTemplateView using the "source" view.

func ValidateRegexpView added in v1.0.6 

func ValidateRegexpView(result *RegexpView) (err error)

ValidateRegexpView runs the validations defined on RegexpView.

func ValidateResolutionActionView added in v1.0.6 

func ValidateResolutionActionView(result *ResolutionActionView) (err error)

ValidateResolutionActionView runs the validations defined on ResolutionActionView using the "default" view.

func ValidateResolutionView added in v1.0.6 

func ValidateResolutionView(result *ResolutionView) (err error)

ValidateResolutionView runs the validations defined on ResolutionView using the "default" view.

func ValidateResolutions added in v1.0.6 

func ValidateResolutions(result *Resolutions) (err error)

ValidateResolutions runs the validations defined on the viewed result type Resolutions.

func ValidateResolutionsView added in v1.0.6 

func ValidateResolutionsView(result *ResolutionsView) (err error)

ValidateResolutionsView runs the validations defined on ResolutionsView using the "default" view.

func ValidateUserView added in v1.0.6 

func ValidateUserView(result *UserView) (err error)

ValidateUserView runs the validations defined on UserView.

Types

type AppliedPolicyView 

type AppliedPolicyView struct {
	// id identifies an applied policy by ID.
	ID *string
	// policy_aggregate_id is set if applied policy is part of an policy aggregate.
	PolicyAggregateID *string
	// incident_aggregate_id is set if applied incident is part of an policy
	// aggregate.
	IncidentAggregateID *string
	// name provides a name for this specific application of the policy.
	Name *string
	// Project represents a RightScale project and provides some information about
	// the project.
	Project *ProjectView
	// href is the href of the applied policy.
	Href *string
	// policy_template links to key attributes of the policy template from which
	// the applied policy originated.
	PolicyTemplate *PolicyTemplateView
	// published_template links to key attributes of the published template from
	// which the applied policy originated.
	PublishedTemplate *PublishedTemplateView
	// description provides a human readable description for this specific
	// application of the policy.
	Description *string
	// doc_link is a HTTP URI to a page containing detailed documentation for the
	// policy.
	DocLink *string
	// info is an arbitrary set of key/value pairs that provide additional
	// information such as the policy author, support contact information, etc.
	Info map[string]string
	// created_by is the RightScale user that applied the policy.
	CreatedBy *UserView
	// created_at is the applied policy creation timestamp in RFC3339 format.
	CreatedAt *string
	// updated_at is the applied policy update timestamp in RFC3339 format.
	UpdatedAt *string
	// severity defines the severity level of incidents raised from this applied
	// policy.
	Severity *string
	// category is the type categorization of the applied policy.
	Category *string
	// frequency specifies the frequency with which to run policy evaluations
	Frequency *string
	// dry_run is a flag used for testing a policy so that an incident can be
	// raised without performing an action.
	DryRun *bool
	// skip_approvals means that any approval actions will be skipped and all
	// actions automatically run.
	SkipApprovals *bool
	// options lists the configuration options used to parameterize the policy.
	Options []*ConfigurationOptionView
	// credentials is the map of name to credential used to launch the policy.
	Credentials map[string]string
	// status is used to identify the current status of the applied policy.
	Status *string
	// error is the error message returned if the evaluation failed. On success
	// this attribute is empty.
	Error *string
	// errored_at is the applied policy error timestamp in RFC3339 format. On
	// success this attribute is empty.
	ErroredAt *string
	// scope is whether the policy is managed at an org-wide or project level.
	Scope *string
	// kind is "gov#applied_policy".
	Kind *string
}

AppliedPolicyView is a type that runs validations on a projected type.

type ApprovalRequestView 

type ApprovalRequestView struct {
	// id identifies an approval request by ID.
	ID *string
	// project_id is the ID of the project where this approval request is created.
	ProjectID *uint
	// href is the href of the approval request
	Href *string
	// label is a short title for this approval request
	Label *string
	// description describes the details for this approval request.
	Description *string
	// subject is the subject of the approval.
	Subject *ApprovalSubject
	// created_at is the approval request creation timestamp in RFC3339 format.
	CreatedAt *string
	// updated_at is the last update timestamp in RFC3339 format.
	UpdatedAt *string
	// parameters is a list of parameters required for approval request.
	Parameters map[string]*ParameterView
	// status is the status of this approval request.
	Status *string
	// options lists the configuration options used to parameterize the approval
	// request.
	Options []*ConfigurationOptionView
	// approved_by is the RightScale user that approved this approval request.
	ApprovedBy *UserView
	// approved_at is the approval timestamp in RFC3339 format.
	ApprovedAt *string
	// denial_comment is a comment that explains the reason for denial, if relevant.
	DenialComment *string
	// denied_by is the RightScale user that denied this approval request.
	DeniedBy *UserView
	// denied_at is the denial timestamp in RFC3339 format.
	DeniedAt *string
	// kind is "gov#approval_request".
	Kind *string
}

ApprovalRequestView is a type that runs validations on a projected type.

type ApprovalSubject added in v1.0.6 

type ApprovalSubject struct {
	// kind is the kind of subject
	Kind *string
	// href is the href of the subject.
	Href *string
}

ApprovalSubject is a type that runs validations on a projected type.

type ConfigurationOptionView 

type ConfigurationOptionView struct {
	// name of option
	Name *string
	// label of option
	Label *string
	// type of option
	Type *string
	// value of option
	Value interface{}
}

ConfigurationOptionView is a type that runs validations on a projected type.

type CredentialsTagView added in v1.0.6 

type CredentialsTagView struct {
	// Key is the tag key.
	Key *string `json:"key"`
	// Value is the tag value.
	Value *string `json:"value"`
}

CredentialsTagView is a type that runs validations on a projected type.

type CredentialsView added in v1.0.6 

type CredentialsView struct {
	// Name in policy template source code
	Name *string `json:"name"`
	// Schemes of credentials service resource supported.
	Schemes []string `json:"schemes"`
	// Label for the auth reference
	Label *string `json:"label"`
	// Description of what types of permissions need to be provided by auth.
	Description *string `json:"description"`
	// Tags is an optional filter to only show credentials matching a certain tag.
	Tags []*CredentialsTagView `json:"tags"`
}

CredentialsView is a type that runs validations on a projected type.

type EscalationActionView 

type EscalationActionView struct {
	// type is the type of the action.
	Type *string
	// status is the status of the action.
	Status *string
	// started_at is the time when the action was started.
	StartedAt *string
	// finished_at is the time when the action was finished.
	FinishedAt *string
	// error is any error occurred when handling the action.
	Error *string
	// approval_request is the approval request resource (if the type is
	// request_approval).
	ApprovalRequest *ApprovalRequestView
	// process_href is the href of a cloud workflow process. Required if the type
	// is cloud_workflow.
	ProcessHref *string
}

EscalationActionView is a type that runs validations on a projected type.

type EscalationView 

type EscalationView struct {
	// status is the status of the set of escalation actions.
	Status *string
	// name is the name of the escalation.
	Name *string
	// actions is the list of individual actions.
	Actions []*EscalationActionView
}

EscalationView is a type that runs validations on a projected type.

type Escalations 

type Escalations struct {
	// Type to project
	Projected *EscalationsView
	// View to render
	View string
}

Escalations is the viewed result type that is projected based on a view.

type EscalationsView 

type EscalationsView struct {
	// status is the status of all of the escalations.
	Status *string
	// escalations is the set of escalations.
	Escalations []*EscalationView
	// started_at is the time when the incident handling is started.
	StartedAt *string
	// finished_at is the time when the incident handling is finished. It exists
	// when the status is completed or failed.
	FinishedAt *string
}

EscalationsView is a type that runs validations on a projected type.

type Incident 

type Incident struct {
	// Type to project
	Projected *IncidentView
	// View to render
	View string
}

Incident is the viewed result type that is projected based on a view.

type IncidentCollectionView 

type IncidentCollectionView []*IncidentView

IncidentCollectionView is a type that runs validations on a projected type.

type IncidentList 

type IncidentList struct {
	// Type to project
	Projected *IncidentListView
	// View to render
	View string
}

IncidentList is the viewed result type that is projected based on a view.

type IncidentListView 

type IncidentListView struct {
	// count is the number of incidents in the list.
	Count *uint
	// etag is an HTTP ETag for the incident list.
	Etag *string
	// items is the array of incidents.
	Items IncidentCollectionView
	// not_modified is a flag used internally that indicates how to encode the HTTP
	// response (i.e. 200 or 304).
	NotModified *string
	// kind is "gov#incident_list".
	Kind *string
}

IncidentListView is a type that runs validations on a projected type.

type IncidentView 

type IncidentView struct {
	// id is the ID of the incident, must be unique in the project.
	ID *string
	// incident_aggregate_id is set if incident is part of an incident aggregate.
	IncidentAggregateID *string
	// Project represents a RightScale project and provides some information about
	// the project.
	Project *ProjectView
	// href is the href of the incident.
	Href *string
	// applied_policy links to key attributes of the applied policy that initiated
	// the incident.
	AppliedPolicy *AppliedPolicyView
	// summary is a summary of the incident.
	Summary *string
	// message is a description of the incident.
	Detail *string
	// data is the data about the resources that violate the policy.
	Data interface{}
	// The number of items in violation data.
	ViolationDataCount *uint
	// created_at is the incident creation timestamp in RFC3339 format.
	CreatedAt *string
	// updated_at is the incident update timestamp in RFC3339 format.
	UpdatedAt *string
	// resolved_at is the incident resolution timestamp in RFC3339 format.
	ResolvedAt *string
	// resolved_by is the RightScale user that resolved the incident if it was
	// resolved manually.
	ResolvedBy *UserView
	// resolution_message is an optional explaination of why the incident is
	// resolved.
	ResolutionMessage *string
	// state represents the current handling status of the incident.
	State *string
	// severity defines the severity level of the incident.
	Severity *string
	// category is the type categorization of the incident.
	Category *string
	// options lists the configuration options used to parameterize the policy that
	// created the incident.
	Options []*ConfigurationOptionView
	// dry_run is a flag used for testing a policy, that determines whether this
	// incident should trigger escalation actions.
	DryRun *bool
	// action_failed indicates whether any of the incident's actions failed during
	// execution.
	ActionFailed *bool
	// kind is "gov#incident".
	Kind *string
	// etag is an HTTP ETag for the incident.
	Etag *string
	// not_modified is a flag used internally that indicates how to encode the HTTP
	// response (i.e. 200 or 304).
	NotModified *string
}

IncidentView is a type that runs validations on a projected type.

type ParameterView 

type ParameterView struct {
	// Name of the parameter
	Name *string `json:"name"`
	// Type of the parameter
	Type *string `json:"type"`
	// Label to show in the UI
	Label *string `json:"label"`
	// The index of this parameter in the list
	Index *uint `json:"index"`
	// The category used to group parameters
	Category *string `json:"category"`
	// Description of the parameter
	Description *string `json:"description"`
	// The default value for the parameter
	Default interface{} `json:"default"`
	// no_echo determines whether the value of the parameter should be hidden in
	// UIs and API responses.
	NoEcho *bool `json:"no_echo"`
	// List of values allowed for this parameter
	AllowedValues []interface{} `json:"allowed_values"`
	// The minimum length of a string parameter
	MinLength *uint `json:"min_length"`
	// The maximum length of a string parameter
	MaxLength *uint `json:"max_length"`
	// The minimum value of a number parmameter
	MinValue *float64 `json:"min_value"`
	// The maximum value of a number parameter
	MaxValue *float64 `json:"max_value"`
	// The regular expression pattern used to validate a string parameter
	AllowedPattern *RegexpView `json:"allowed_pattern"`
	// The description used for constraints
	ConstraintDescription *string `json:"constraint_description"`
}

ParameterView is a type that runs validations on a projected type.

type PermissionView 

type PermissionView struct {
	// Name of a permission
	Name *string `json:"name"`
	// Label is used in the UI
	Label *string `json:"label"`
	// List of resource names the permission is applied to
	Resources []string `json:"resources"`
	// List of action names the permission is applied to
	Actions []string `json:"actions"`
}

PermissionView is a type that runs validations on a projected type.

type PolicyTemplateView 

type PolicyTemplateView struct {
	// id identifies a policy template by ID.
	ID *string
	// name is the unique name of the policy template in the project.
	Name *string
	// project_id is the ID of the project that the policy template applies to.
	ProjectID *uint
	// rs_pt_ver is the policy engine version.
	RsPtVer *uint
	// short_description is the short description of the policy template.
	ShortDescription *string
	// long_description is the long description of the policy template. The content
	// can be markdown.
	LongDescription *string
	// doc_link is an HTTP URI to a page containing detailed documentation for the
	// policy.
	DocLink *string
	// info is an arbitrary set of key/value pairs that provide additional
	// information such as the policy author, support contact information, etc.
	Info map[string]string
	// default_frequency defines the interval the template will be run unless set
	// differently during application.
	DefaultFrequency *string
	// href is the href of the policy template.
	Href *string
	// filename is the name of the file that was uploaded to create the policy
	// template.
	Filename *string
	// source is the policy template source code.
	Source *string
	// fingerprint is a SHA created during compilation. It is used to determine if
	// the template is outdated.
	Fingerprint *string
	// category is the type categorization of the policy template.
	Category *string
	// created_by is the RightScale user that created the policy template.
	CreatedBy *UserView
	// created_at is the policy template creation timestamp in RFC3339 format.
	CreatedAt *string
	// updated_by is the RightScale user that updated the policy template.
	UpdatedBy *UserView
	// updated_at is the last update timestamp in RFC3339 format.
	UpdatedAt *string
	// permissions is a list of permissions required to run the policy.
	Permissions map[string]*PermissionView
	// required_roles is a list of governance roles, derived from permissions,
	// required to run the policy.
	RequiredRoles []string
	// parameters is a list of parameters required to apply the policy.
	Parameters map[string]*ParameterView
	// severity defines the severity level of incidents raised from this policy
	// template.
	Severity *string
	// tenancy indicates whether this template can be run across multiple projects
	// or is restricted to a single project.
	Tenancy *string
	// credentials is a list of authorization for external APIs needed to run the
	// policy.
	Credentials map[string]*CredentialsView
	// kind is "gov#policy_template".
	Kind *string
}

PolicyTemplateView is a type that runs validations on a projected type.

type ProjectView 

type ProjectView struct {
	// id is the Project ID
	ID *uint
	// name is the Project Name
	Name *string
	// org_id is the RightScale Organization ID
	OrgID *uint
	// org_name is the RightScale Organization Name
	OrgName *string
}

ProjectView is a type that runs validations on a projected type.

type PublishedTemplateView 

type PublishedTemplateView struct {
	// id identifies a published template by ID.
	ID *string
	// name is the unique name of the published template in the organization.
	Name *string
	// org_id is the ID of the organization that the published template belongs to.
	OrgID *uint
	// project_id is the ID of the project that the published template is published
	// from.
	ProjectID *uint
	// policy_template_id is the ID of the policy template from which the published
	// template originated.
	PolicyTemplateID *string
	// policy_template_url is the full URL to the policy template from which the
	// published template originated.
	PolicyTemplateURL *string
	// policy_template_fingerprint is fingerprint of the policy template. It is
	// used to determine if the policy template that this was published from is
	// outdated.
	PolicyTemplateFingerprint *string
	// rs_pt_ver is the policy engine version.
	RsPtVer *uint
	// short_description is the short description of the published template.
	ShortDescription *string
	// long_description is the long description of the published template. The
	// content can be markdown.
	LongDescription *string
	// doc_link is a HTTP URI to a page containing detailed documentation for the
	// policy.
	DocLink *string
	// info is an arbitrary set of key/value pairs that provide additional
	// information such as the policy author, support contact information, etc.
	Info map[string]string
	// default_frequency defines the interval the template will be run unless set
	// differently during application.
	DefaultFrequency *string
	// href is the self-referential href of the published template.
	Href *string
	// filename is the name of the file that was uploaded to create the policy
	// template.
	Filename *string
	// source is published template source code.
	Source *string
	// fingerprint is a SHA created during compilation. It is used to determine if
	// the policy template that this was published from is outdated.
	Fingerprint *string
	// category is the type categorization of the published template.
	Category *string
	// created_by is the RightScale user that created the published template.
	CreatedBy *UserView
	// created_at is the published template creation timestamp in RFC3339 format.
	CreatedAt *string
	// updated_by is the RightScale user that updated the published template.
	UpdatedBy *UserView
	// updated_at is the published template update timestamp in RFC3339 format.
	UpdatedAt *string
	// permissions is a list of permissions required to run the policy.
	Permissions map[string]*PermissionView
	// required_roles is a list of governance roles, derived from permissions,
	// required to run the policy.
	RequiredRoles []string
	// parameters is a list of parameters required to apply the policy.
	Parameters map[string]*ParameterView
	// severity defines the severity level of incidents raised from this published
	// template.
	Severity *string
	// built_in is a flag to indicate whether the published template is a
	// "built-in" RS-supplied template.
	BuiltIn *bool
	// hidden is a flag to indicate whether the published template is hidden.
	Hidden *bool
	// hidden_by is the RightScale user that marked the published template as
	// hidden.
	HiddenBy *UserView
	// hidden_at is the hidden at timestamp in RFC3339 format.
	HiddenAt *string
	// tenancy indicates whether this template can be run across multiple projects
	// or is restricted to a single project.
	Tenancy *string
	// credentials is a list of authorization for external APIs needed to run the
	// policy.
	Credentials map[string]*CredentialsView
	// kind is "gov#published_template".
	Kind *string
}

PublishedTemplateView is a type that runs validations on a projected type.

type RegexpView 

type RegexpView struct {
	// Pattern is the regular expression pattern.
	Pattern *string `json:"pattern"`
	// Options are the regular expression options. Options i (case insensitve) and
	// m (match over newlines) supported.
	Options *string `json:"options"`
}

RegexpView is a type that runs validations on a projected type.

type ResolutionActionView 

type ResolutionActionView struct {
	// type is the type of the action.
	Type *string
	// status is the status of the action.
	Status *string
	// started_at is the time when the action was started.
	StartedAt *string
	// finished_at is the time when the action was finished.
	FinishedAt *string
	// error is any error occurred when handling the action.
	Error *string
	// approval_request is the approval request resource (if the type is
	// request_approval).
	ApprovalRequest *ApprovalRequestView
	// process_href is the href of a cloud workflow process. Required if the type
	// is cloud_workflow.
	ProcessHref *string
}

ResolutionActionView is a type that runs validations on a projected type.

type ResolutionView 

type ResolutionView struct {
	// status is the status of the set of resolution actions.
	Status *string
	// name is the name of the resolution.
	Name *string
	// actions is the list of individual actions.
	Actions []*ResolutionActionView
}

ResolutionView is a type that runs validations on a projected type.

type Resolutions 

type Resolutions struct {
	// Type to project
	Projected *ResolutionsView
	// View to render
	View string
}

Resolutions is the viewed result type that is projected based on a view.

type ResolutionsView 

type ResolutionsView struct {
	// status is the status of all of the resolutions.
	Status *string
	// resolutions is the set of resolutions.
	Resolutions []*ResolutionView
	// started_at is the time when the incident handling is started.
	StartedAt *string
	// finished_at is the time when the incident handling is finished. It exists
	// when the status is completed or failed.
	FinishedAt *string
}

ResolutionsView is a type that runs validations on a projected type.

type UserView 

type UserView struct {
	// ID of user
	ID *uint
	// email of user
	Email *string
	// name of user, usually of the form 'First Last'
	Name *string
}

UserView is a type that runs validations on a projected type.

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.