aws.go

package objects

// THIS FILE IS AUTO GENERATED BY bin/gen.go! DO NOT EDIT!

import (
	"fmt"

	"github.com/esurdam/go-sophos"
)

// Aws is a generated struct representing the Sophos Aws Endpoint
// GET /api/nodes/aws
type Aws struct {
	AwsGroup        AwsGroup        `json:"aws_group"`
	AwsInstanceType AwsInstanceType `json:"aws_instance_type"`
	AwsRegion       AwsRegion       `json:"aws_region"`
}

var _ sophos.Endpoint = &Aws{}

var defsAws = map[string]sophos.RestObject{
	"AwsGroup":        &AwsGroup{},
	"AwsInstanceType": &AwsInstanceType{},
	"AwsRegion":       &AwsRegion{},
}

// RestObjects implements the sophos.Node interface and returns a map of Aws's Objects
func (Aws) RestObjects() map[string]sophos.RestObject { return defsAws }

// GetPath implements sophos.RestGetter
func (*Aws) GetPath() string { return "/api/nodes/aws" }

// RefRequired implements sophos.RestGetter
func (*Aws) RefRequired() (string, bool) { return "", false }

var defAws = &sophos.Definition{Description: "aws", Name: "aws", Link: "/api/definitions/aws"}

// Definition returns the /api/definitions struct of Aws
func (Aws) Definition() sophos.Definition { return *defAws }

// ApiRoutes returns all known Aws Paths
func (Aws) ApiRoutes() []string {
	return []string{
		"/api/objects/aws/group/",
		"/api/objects/aws/group/{ref}",
		"/api/objects/aws/group/{ref}/usedby",
		"/api/objects/aws/instance_type/",
		"/api/objects/aws/instance_type/{ref}",
		"/api/objects/aws/instance_type/{ref}/usedby",
		"/api/objects/aws/region/",
		"/api/objects/aws/region/{ref}",
		"/api/objects/aws/region/{ref}/usedby",
	}
}

// References returns the Aws's references. These strings serve no purpose other than to demonstrate which
// Reference keys are used for this Endpoint
func (Aws) References() []string {
	return []string{
		"REF_AwsGroup",
		"REF_AwsInstanceType",
		"REF_AwsRegion",
	}
}

// AwsGroups is an Sophos Endpoint subType and implements sophos.RestObject
type AwsGroups []AwsGroup

// AwsGroup represents a UTM aws->group
type AwsGroup struct {
	Locked     string `json:"_locked"`
	ObjectType string `json:"_type"`
	Reference  string `json:"_ref"`
	Comment    string `json:"comment"`
	Name       string `json:"name"`
}

var _ sophos.RestGetter = &AwsGroup{}

// GetPath implements sophos.RestObject and returns the AwsGroups GET path
// Returns all available aws/group objects
func (*AwsGroups) GetPath() string { return "/api/objects/aws/group/" }

// RefRequired implements sophos.RestObject
func (*AwsGroups) RefRequired() (string, bool) { return "", false }

// GetPath implements sophos.RestObject and returns the AwsGroups GET path
// Returns all available group types
func (a *AwsGroup) GetPath() string { return fmt.Sprintf("/api/objects/aws/group/%s", a.Reference) }

// RefRequired implements sophos.RestObject
func (a *AwsGroup) RefRequired() (string, bool) { return a.Reference, true }

// DeletePath implements sophos.RestObject and returns the AwsGroup DELETE path
// Creates or updates the complete object group
func (*AwsGroup) DeletePath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/group/%s", ref)
}

// PatchPath implements sophos.RestObject and returns the AwsGroup PATCH path
// Changes to parts of the object group types
func (*AwsGroup) PatchPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/group/%s", ref)
}

// PostPath implements sophos.RestObject and returns the AwsGroup POST path
// Create a new aws/group object
func (*AwsGroup) PostPath() string {
	return "/api/objects/aws/group/"
}

// PutPath implements sophos.RestObject and returns the AwsGroup PUT path
// Creates or updates the complete object group
func (*AwsGroup) PutPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/group/%s", ref)
}

// UsedByPath implements sophos.RestObject
// Returns the objects and the nodes that use the object with the given ref
func (*AwsGroup) UsedByPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/group/%s/usedby", ref)
}

// AwsInstanceTypes is an Sophos Endpoint subType and implements sophos.RestObject
type AwsInstanceTypes []AwsInstanceType

// AwsInstanceType represents a UTM instance type
type AwsInstanceType struct {
	Locked     string `json:"_locked"`
	ObjectType string `json:"_type"`
	Reference  string `json:"_ref"`
	Comment    string `json:"comment"`
	CpuCores   int    `json:"cpu_cores"`
	// Deprecated default value is false
	Deprecated         bool   `json:"deprecated"`
	MemoryBytes        int    `json:"memory_bytes"`
	Model              string `json:"model"`
	Name               string `json:"name"`
	NetworkPerformance string `json:"network_performance"`
}

var _ sophos.RestGetter = &AwsInstanceType{}

// GetPath implements sophos.RestObject and returns the AwsInstanceTypes GET path
// Returns all available aws/instance_type objects
func (*AwsInstanceTypes) GetPath() string { return "/api/objects/aws/instance_type/" }

// RefRequired implements sophos.RestObject
func (*AwsInstanceTypes) RefRequired() (string, bool) { return "", false }

// GetPath implements sophos.RestObject and returns the AwsInstanceTypes GET path
// Returns all available instance_type types
func (a *AwsInstanceType) GetPath() string {
	return fmt.Sprintf("/api/objects/aws/instance_type/%s", a.Reference)
}

// RefRequired implements sophos.RestObject
func (a *AwsInstanceType) RefRequired() (string, bool) { return a.Reference, true }

// DeletePath implements sophos.RestObject and returns the AwsInstanceType DELETE path
// Creates or updates the complete object instance_type
func (*AwsInstanceType) DeletePath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/instance_type/%s", ref)
}

// PatchPath implements sophos.RestObject and returns the AwsInstanceType PATCH path
// Changes to parts of the object instance_type types
func (*AwsInstanceType) PatchPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/instance_type/%s", ref)
}

// PostPath implements sophos.RestObject and returns the AwsInstanceType POST path
// Create a new aws/instance_type object
func (*AwsInstanceType) PostPath() string {
	return "/api/objects/aws/instance_type/"
}

// PutPath implements sophos.RestObject and returns the AwsInstanceType PUT path
// Creates or updates the complete object instance_type
func (*AwsInstanceType) PutPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/instance_type/%s", ref)
}

// UsedByPath implements sophos.RestObject
// Returns the objects and the nodes that use the object with the given ref
func (*AwsInstanceType) UsedByPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/instance_type/%s/usedby", ref)
}

// AwsRegions is an Sophos Endpoint subType and implements sophos.RestObject
type AwsRegions []AwsRegion

// AwsRegion represents a UTM region
type AwsRegion struct {
	Locked            string   `json:"_locked"`
	ObjectType        string   `json:"_type"`
	Reference         string   `json:"_ref"`
	AvailabilityZones []string `json:"availability_zones"`
	Code              string   `json:"code"`
	Comment           string   `json:"comment"`
	InstanceTypes     []string `json:"instance_types"`
	Name              string   `json:"name"`
	Partition         string   `json:"partition"`
}

var _ sophos.RestGetter = &AwsRegion{}

// GetPath implements sophos.RestObject and returns the AwsRegions GET path
// Returns all available aws/region objects
func (*AwsRegions) GetPath() string { return "/api/objects/aws/region/" }

// RefRequired implements sophos.RestObject
func (*AwsRegions) RefRequired() (string, bool) { return "", false }

// GetPath implements sophos.RestObject and returns the AwsRegions GET path
// Returns all available region types
func (a *AwsRegion) GetPath() string { return fmt.Sprintf("/api/objects/aws/region/%s", a.Reference) }

// RefRequired implements sophos.RestObject
func (a *AwsRegion) RefRequired() (string, bool) { return a.Reference, true }

// DeletePath implements sophos.RestObject and returns the AwsRegion DELETE path
// Creates or updates the complete object region
func (*AwsRegion) DeletePath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/region/%s", ref)
}

// PatchPath implements sophos.RestObject and returns the AwsRegion PATCH path
// Changes to parts of the object region types
func (*AwsRegion) PatchPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/region/%s", ref)
}

// PostPath implements sophos.RestObject and returns the AwsRegion POST path
// Create a new aws/region object
func (*AwsRegion) PostPath() string {
	return "/api/objects/aws/region/"
}

// PutPath implements sophos.RestObject and returns the AwsRegion PUT path
// Creates or updates the complete object region
func (*AwsRegion) PutPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/region/%s", ref)
}

// UsedByPath implements sophos.RestObject
// Returns the objects and the nodes that use the object with the given ref
func (*AwsRegion) UsedByPath(ref string) string {
	return fmt.Sprintf("/api/objects/aws/region/%s/usedby", ref)
}