actionstatus

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Apr 27, 2022 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source 
const ServiceName = "ActionStatus"

ServiceName is the name of the service as defined in the design. This is the same value that is set in the endpoint request contexts under the ServiceKey key.

Variables

View Source 
var MethodNames = [2]string{"index", "show"}

MethodNames lists the service method names as defined in the design. These are the same values that are set in the endpoint request contexts under the MethodKey key.

Functions

func MakeBadGateway 

func MakeBadGateway(err error) *goa.ServiceError

MakeBadGateway builds a goa.ServiceError from an error.

func MakeBadRequest 

func MakeBadRequest(err error) *goa.ServiceError

MakeBadRequest builds a goa.ServiceError from an error.

func MakeForbidden 

func MakeForbidden(err error) *goa.ServiceError

MakeForbidden builds a goa.ServiceError from an error.

func MakeInternalError 

func MakeInternalError(err error) *goa.ServiceError

MakeInternalError builds a goa.ServiceError from an error.

func MakeNotFound 

func MakeNotFound(err error) *goa.ServiceError

MakeNotFound builds a goa.ServiceError from an error.

func MakeUnauthorized 

func MakeUnauthorized(err error) *goa.ServiceError

MakeUnauthorized builds a goa.ServiceError from an error.

func NewIndexEndpoint 

func NewIndexEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint

NewIndexEndpoint returns an endpoint function that calls the method "index" of service "ActionStatus".

func NewShowEndpoint 

func NewShowEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint

NewShowEndpoint returns an endpoint function that calls the method "show" of service "ActionStatus".

func NewViewedActionStatus 

func NewViewedActionStatus(res *ActionStatus, view string) *actionstatusviews.ActionStatus

NewViewedActionStatus initializes viewed result type ActionStatus from result type ActionStatus using the given view.

func NewViewedActionStatusList 

func NewViewedActionStatusList(res *ActionStatusList, view string) *actionstatusviews.ActionStatusList

NewViewedActionStatusList initializes viewed result type ActionStatusList from result type ActionStatusList using the given view.

Types

type ActionItemStatus 

type ActionItemStatus struct {
	// type of the action item.
	Type string
	// status of the action item.
	Status string
	// started_at is the time when the action item was started.
	StartedAt *string
	// finished_at is the time when the action item was finished.
	FinishedAt *string
	// error is any error that occurred when handling the action item.
	Error *string
	// approval_request_href is an href of the approval request. Required if the
	// type is request_approval.
	ApprovalRequestHref *string
	// process_href is a url of a cloud workflow process. Required if the type is
	// cloud_workflow.
	ProcessHref *string
}

ActionItemStatus holds the status of a single step in an action.

type ActionStatus 

type ActionStatus struct {
	// id is a unique identifier for this action status.
	ID string
	// status of the action.
	Status string
	// name is an identifier for the action.
	Name string
	// type is the type of action, which also indicates the situations in which it
	// is used.
	Type string
	// label is the human readable name for the action.
	Label *string
	// run_by is the Flexera user that ran the action. If the action was applied
	// automatically, this will be who applied the action.
	RunBy *User
	// whether or not this action is automatically run.
	Automatic *bool
	// options lists the configuration options used to parameterize the action.
	Options []*ConfigurationOption
	// started_at is the time when the action was started.
	StartedAt *string
	// finished_at is the time when the action was finished.
	FinishedAt *string
	// actions is the list of individual steps within this action and their success
	// or failure.
	ActionItems []*ActionItemStatus
	// kind is "gov#action_status".
	Kind string
}

ActionStatus is the result type of the ActionStatus service show method.

func NewActionStatus 

func NewActionStatus(vres *actionstatusviews.ActionStatus) *ActionStatus

NewActionStatus initializes result type ActionStatus from viewed result type ActionStatus.

type ActionStatusCollection 

type ActionStatusCollection []*ActionStatus

type ActionStatusList 

type ActionStatusList struct {
	// count is the number of action statuss in the list.
	Count *uint
	// etag is an HTTP ETag for the action list.
	Etag string
	// items is the array of action statuses.
	Items ActionStatusCollection
	// 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#action_status_list".
	Kind string
}

ActionStatusList is the result type of the ActionStatus service index method.

func NewActionStatusList 

func NewActionStatusList(vres *actionstatusviews.ActionStatusList) *ActionStatusList

NewActionStatusList initializes result type ActionStatusList from viewed result type ActionStatusList.

type Auther 

type Auther interface {
	// JWTAuth implements the authorization logic for the JWT security scheme.
	JWTAuth(ctx context.Context, token string, schema *security.JWTScheme) (context.Context, error)
}

Auther defines the authorization functions to be implemented by the service.

type Client 

type Client struct {
	IndexEndpoint goa.Endpoint
	ShowEndpoint  goa.Endpoint
}

Client is the "ActionStatus" service client.

func NewClient 

func NewClient(index, show goa.Endpoint) *Client

NewClient initializes a "ActionStatus" service client given the endpoints.

func (*Client) Index 

func (c *Client) Index(ctx context.Context, p *IndexPayload) (res *ActionStatusList, err error)

Index calls the "index" endpoint of the "ActionStatus" service.

func (*Client) Show 

func (c *Client) Show(ctx context.Context, p *ShowPayload) (res *ActionStatus, err error)

Show calls the "show" endpoint of the "ActionStatus" service. Show may return the following errors:

  • "not_found" (type *goa.ServiceError)
  • error: internal error

type ConfigurationOption 

type ConfigurationOption struct {
	// name of option
	Name string
	// label of option
	Label string
	// type of option
	Type string
	// value of option
	Value interface{}
	// no_echo determines whether the value of the configuration option should be
	// hidden in UIs and API responses.
	NoEcho bool
}

ConfigurationOption describes a single parameter value used to configure an applied policy.

type Endpoints 

type Endpoints struct {
	Index goa.Endpoint
	Show  goa.Endpoint
}

Endpoints wraps the "ActionStatus" service endpoints.

func NewEndpoints 

func NewEndpoints(s Service) *Endpoints

NewEndpoints wraps the methods of the "ActionStatus" service with endpoints.

func (*Endpoints) Use 

func (e *Endpoints) Use(m func(goa.Endpoint) goa.Endpoint)

Use applies the given middleware to all the "ActionStatus" service endpoints.

type IndexPayload 

type IndexPayload struct {
	// project_id identifies a project by ID.
	ProjectID uint
	// incident_id is a filter to only show action statuses that relate to a
	// certain incident.
	IncidentID *string
	// applied_policy_id is a filter to only show action statuses that relate to a
	// certain applied policy.
	AppliedPolicyID *string
	// etag is an HTTP ETag. It is typically the previous ETag value retrieved by
	// client if any. Service returns an empty response with HTTP status code 304
	// Not Modified if value matches current value server side.
	Etag *string
	// View used to render incident status
	View *string
	// JWT token used to perform authorization
	Token *string
	// API Version, must be specified using this header
	APIVersion string
}

IndexPayload is the payload type of the ActionStatus service index method.

type Service 

type Service interface {
	// Index returns a list of action statuses in a project.
	// The "view" return value must have one of the following views
	//	- "default"
	//	- "extended"
	Index(context.Context, *IndexPayload) (res *ActionStatusList, view string, err error)
	// Show retrieves the details of an action status.
	// The "view" return value must have one of the following views
	//	- "default"
	//	- "extended"
	Show(context.Context, *ShowPayload) (res *ActionStatus, view string, err error)
}

Service is the ActionStatus service interface.

type ShowPayload 

type ShowPayload struct {
	// project_id identifies a project by ID.
	ProjectID uint
	// id identifies an action status by ID.
	ID string
	// View used to render action status
	View *string
	// JWT token used to perform authorization
	Token *string
	// API Version, must be specified using this header
	APIVersion string
}

ShowPayload is the payload type of the ActionStatus service show method.

type User 

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

User represents a registered RightScale user.

Source Files

View all Source files

Directories

Path Synopsis

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.