resources

Documentation

Index

• type AuxData
• type AuxUploadResult
• type ConfigData
• type ConfigUploadResult
• type ConfigVersion
• type DeploymentDetail
• type DeploymentDetails
• type Directory
• type DirectoryMap
• type ErrorDetail
• type ErrorModel
• type ExternalId
• type ExternalIdType
• type FileData
• type GroupConfigVersion
• type InstanceActivityStatus
• type InstanceGroup
• type InstanceGroupConfigResponse
• type InstanceGroupListResponse
• type InstanceGroupSimple
• type InstanceStatus
• type ListConfigsResponse
• type LoadInstanceGroups
• type NamedLinks
• type PaginationResponse
• type PublishConfigRequest
• type PublishConfigResponse
• type SavedNginxConfigSummary
• type SelfLinks
• type UploadConfigRequest
• type UploadConfigResponse
• type UploadResult

Types

type AuxData

type AuxData struct {
	Files   []FileData `json:"files"`
	RootDir string     `json:"rootDir"`
}

AuxData represents auxiliary configuration files.

type AuxUploadResult

type AuxUploadResult struct {
	FileName string `json:"fileName"`
	Result   string `json:"result"`
	Size     int    `json:"size"`
}

AuxUploadResult represents details of aux file actions and results for an upload.

type ConfigData

type ConfigData struct {
	Files   []FileData `json:"files"`
	RootDir string     `json:"rootDir"`
}

ConfigData represents NGINX configuration files.

type ConfigUploadResult

type ConfigUploadResult struct {
	FileName string `json:"fileName"`
	Result   string `json:"result"`
	Size     int    `json:"size"`
}

ConfigUploadResult represents details of config file actions and results for an upload.

type ConfigVersion

type ConfigVersion struct {
	CreateTime     time.Time      `json:"createTime"`
	ExternalId     ExternalId     `json:"externalId"`
	ExternalIdType ExternalIdType `json:"externalIdType"`
	UID            string         `json:"uid"`
	VersionHash    string         `json:"versionHash"`
}

ConfigVersion represents the configuration version for an NGINX instance or instance group.

type DeploymentDetail

type DeploymentDetail struct {
	Error   string                   `json:"error"`
	Failure []InstanceStatus         `json:"failure"`
	Pending []InstanceActivityStatus `json:"pending"`
	Success []InstanceStatus         `json:"success"`
}

DeploymentDetail represents additional deployment details for NGINX instances in the group.

type DeploymentDetails

type DeploymentDetails struct {
	CreateTime time.Time        `json:"createTime"`
	Details    DeploymentDetail `json:"details"`
	ID         string           `json:"id"`
	Message    string           `json:"message"`
	Status     string           `json:"status"`
	UpdateTime time.Time        `json:"updateTime"`
}

DeploymentDetails represents the outcome of a Publish request for an NGINX instance or Instance Group.

type Directory

type Directory struct {
	Files       []FileData `json:"files"`
	Name        string     `json:"name"`
	Permissions string     `json:"permissions"`
	Size        int        `json:"size"`
	UpdateTime  time.Time  `json:"updateTime"`
}

Directory represents information about a directory.

type DirectoryMap

type DirectoryMap map[string]Directory

DirectoryMap represents a map of directories.

type ErrorDetail

type ErrorDetail struct {
	Description string `json:"description"`
}

ErrorDetail represents a detailed error message returned by the server.

type ErrorModel

type ErrorModel struct {
	Code    int           `json:"code"`
	Details []ErrorDetail `json:"details"`
	Message string        `json:"message"`
}

ErrorModel represents an error, including a numeric error code, details, and a human-readable message.

type ExternalId

type ExternalId string

ExternalId represents the commit ID of the config.

type ExternalIdType

type ExternalIdType string

ExternalIdType represents the type of commit for config update.

type FileData

type FileData struct {
	Contents string `json:"contents"`
	Name     string `json:"name"`
	Size     int    `json:"size"`
}

FileData represents file contents.

type GroupConfigVersion

type GroupConfigVersion struct {
	Instances []ConfigVersion `json:"instances"`
	Versions  []ConfigVersion `json:"versions"`
}

GroupConfigVersion represents the configuration version for an instance group.

type InstanceActivityStatus

type InstanceActivityStatus struct {
	Message string `json:"message"`
	Name    string `json:"name"`
	Status  string `json:"status"`
}

InstanceActivityStatus represents a pending deployment status for an NGINX instance.

type InstanceGroup

type InstanceGroup struct {
	BaseConfigName        string             `json:"baseConfigName"`
	ConfigVersion         GroupConfigVersion `json:"configVersion"`
	Description           string             `json:"description"`
	DisplayName           string             `json:"displayName"`
	Instances             []string           `json:"instances"`
	LastDeploymentDetails DeploymentDetails  `json:"lastDeploymentDetails"`
	Links                 []NamedLinks       `json:"links"`
	Name                  string             `json:"name"`
	UID                   string             `json:"uid"`
}

InstanceGroup defines an instance group and its member instances.

type InstanceGroupConfigResponse

type InstanceGroupConfigResponse struct {
	AuxFiles       AuxData        `json:"auxFiles"`
	ConfigFiles    ConfigData     `json:"configFiles"`
	CreateTime     time.Time      `json:"createTime"`
	DirectoryMap   DirectoryMap   `json:"directoryMap"`
	ExternalId     ExternalId     `json:"externalId"`
	ExternalIdType ExternalIdType `json:"externalIdType"`
	Instances      []string       `json:"instances"`
	UpdateTime     time.Time      `json:"updateTime"`
}

InstanceGroupConfigResponse represents the configuration details for an NGINX instance group.

type InstanceGroupListResponse

type InstanceGroupListResponse struct {
	PaginationResponse
	Items []InstanceGroup `json:"items"`
}

InstanceGroupListResponse represents a list of NGINX instance group descriptions.

type InstanceGroupSimple

type InstanceGroupSimple struct {
	Description    string         `json:"description"`
	DisplayName    string         `json:"displayName"`
	ExternalId     ExternalId     `json:"externalId"`
	ExternalIdType ExternalIdType `json:"externalIdType"`
	Name           string         `json:"name"`
	UID            string         `json:"uid"`
}

InstanceGroupSimple provides a simplified representation of an NGINX instance group.

type InstanceStatus

type InstanceStatus struct {
	FailMessage string `json:"failMessage"`
	FailType    string `json:"failType"`
	Name        string `json:"name"`
}

InstanceStatus represents a success or failure deployment status for an NGINX instance.

type ListConfigsResponse

type ListConfigsResponse struct {
	PaginationResponse
	Items []SavedNginxConfigSummary `json:"items"`
}

ListConfigsResponse represents a list of saved NGINX configuration summaries.

type LoadInstanceGroups

type LoadInstanceGroups struct {
	Count int                   `json:"count"`
	Items []InstanceGroupSimple `json:"items"`
}

LoadInstanceGroups represents a summary list of NGINX instance groups.

type NamedLinks

type NamedLinks struct {
	SelfLinks
	DisplayName string `json:"displayName"`
	Name        string `json:"name"`
}

NamedLinks contains information about the object being referred to.

type PaginationResponse

type PaginationResponse struct {
	Count        int `json:"count"`
	ItemsPerPage int `json:"itemsPerPage"`
	StartIndex   int `json:"startIndex"`
}

PaginationResponse is used in list responses that support pagination.

type PublishConfigRequest

type PublishConfigRequest struct {
	AuxFiles       AuxData        `json:"auxFiles"`
	ConfigFiles    ConfigData     `json:"configFiles"`
	ConfigUID      string         `json:"configUID"`
	ExternalId     ExternalId     `json:"externalId"`
	ExternalIdType ExternalIdType `json:"externalIdType"`
	IgnoreConflict bool           `json:"ignoreConflict"`
	UpdateTime     time.Time      `json:"updateTime"`
	ValidateConfig bool           `json:"validateConfig"`
}

PublishConfigRequest represents a configuration publish request.

type PublishConfigResponse

type PublishConfigResponse struct {
	DeploymentUID string    `json:"deploymentUID"`
	Links         SelfLinks `json:"links"`
	Result        string    `json:"result"`
}

PublishConfigResponse represents the outcome of a publish config.

type SavedNginxConfigSummary

type SavedNginxConfigSummary struct {
	AuxFiles       AuxData        `json:"auxFiles"`
	ConfigFiles    ConfigData     `json:"configFiles"`
	CreateTime     time.Time      `json:"createTime"`
	ExternalId     ExternalId     `json:"externalId"`
	ExternalIdType ExternalIdType `json:"externalIdType"`
	Instances      []string       `json:"instances"`
	Name           string         `json:"name"`
	UpdateTime     time.Time      `json:"updateTime"`
}

SavedNginxConfigSummary defines configuration summary data.

type SelfLinks

type SelfLinks struct {
	Rel string `json:"rel"`
}

SelfLinks contains a link from the resource to itself.

type UploadConfigRequest

type UploadConfigRequest struct {
	AuxFiles       AuxData        `json:"auxFiles"`
	ConfigFiles    ConfigData     `json:"configFiles"`
	ConfigName     string         `json:"configName"`
	ExternalId     ExternalId     `json:"externalId"`
	ExternalIdType ExternalIdType `json:"externalIdType"`
	InstGroupUID   string         `json:"instGroupUid"`
	NginxUID       string         `json:"nginxUid"`
}

UploadConfigRequest represents a configuration upload request.

type UploadConfigResponse

type UploadConfigResponse struct {
	Results UploadResult            `json:"results"`
	Summary SavedNginxConfigSummary `json:"summary"`
}

UploadConfigResponse defines staged configuration upload results.

type UploadResult

type UploadResult struct {
	AuxFiles    []AuxUploadResult    `json:"auxFiles"`
	ConfigFiles []ConfigUploadResult `json:"configFiles"`
}

UploadResult represents details of file actions and results for different types of uploads.