cmd

package
v1.3.1 Latest Latest
Warning

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

Go to latest
Published: Oct 31, 2025 License: BSD-2-Clause Imports: 29 Imported by: 0

Documentation

Overview

Copyright © 2022 NAME HERE <EMAIL ADDRESS>

Copyright © 2022 NAME HERE <EMAIL ADDRESS>

Index

Constants

This section is empty.

Variables

View Source
var ErrSilent = errors.New("ErrSilent")

Functions

func Execute

func Execute() error

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func GetAccountIDByName added in v1.2.1

func GetAccountIDByName(accountName string) (string, error)

func NewRootCommand

func NewRootCommand() *cobra.Command

func NoArgs

func NoArgs(cmd *cobra.Command, args []string) error

Function for commands that provide no arguments. This will turn usage back on so that it will be output if a user tries to pass in an argument when they should not

func RelaxedJSONPathExpression

func RelaxedJSONPathExpression(pathExpression string) (string, error)

RelaxedJSONPathExpression attempts to be flexible with JSONPath expressions, it accepts:

  • metadata.name (no leading '.' or curly braces '{...}'
  • {metadata.name} (no leading '.')
  • .metadata.name (no curly braces '{...}')
  • {.metadata.name} (complete expression)

And transforms them all into a valid jsonpath expression:

{.metadata.name}

Types

type BackupResource

type BackupResource struct {
	Id int `json:"id"`
}

type ChoiceSettings added in v1.2.1

type ChoiceSettings struct {
	ChoiceSet        string   `json:"choiceSet,omitempty"`
	Services         []string `json:"services,omitempty"`
	ExcludedServices []string `json:"excludedServices,omitempty"`
	Family           string   `json:"family,omitempty"`
}

type Connection added in v1.2.1

type Connection struct {
	Name       string                 `json:"name"`
	Category   string                 `json:"category"`
	Type       string                 `json:"type"`
	Owner      string                 `json:"owner"`
	Shareable  bool                   `json:"shareable"`
	Parameters map[string]interface{} `json:"parameters"`
}

type ConnectionCreateFlags added in v1.2.1

type ConnectionCreateFlags struct {
	// contains filtered or unexported fields
}

type ConnectionCreateMessage added in v1.2.1

type ConnectionCreateMessage struct {
	Message string                 `json:"message"`
	Details map[string]interface{} `json:"details"`
}

type ConnectionDeleteFlags added in v1.2.1

type ConnectionDeleteFlags struct {
	// contains filtered or unexported fields
}

type ConnectionUpdateFlags added in v1.2.1

type ConnectionUpdateFlags struct {
	// contains filtered or unexported fields
}

type DeploymentParameter

type DeploymentParameter struct {
	Name            string    `json:"name"`
	Owner           string    `json:"owner"`
	Type            string    `json:"type"`
	Updated         time.Time `json:"updated"`
	Value           string    `json:"value"`
	ResourceMissing bool      `json:"resourceMissing"`
	ChoiceSettings  struct {
		ChoiceSet        string   `json:"choiceSet"`
		Services         []string `json:"services"`
		ExcludedServices []string `json:"excludedServices"`
		Family           string   `json:"family"`
	} `json:"choiceSettings,omitempty"`
}

type DeploymentParameters

type DeploymentParameters struct {
	Items      []DeploymentParameter `json:"items"`
	Limit      int                   `json:"limit"`
	Offset     int                   `json:"offset"`
	TotalCount int                   `json:"totalCount"`
}

type Directive

type Directive struct {
	Name  string `json:"name,omitempty"`
	Value string `json:"value,omitempty"`
}

type EngineV3 added in v1.2.1

type EngineV3 struct {
	HostName                    string        `json:"hostName"`
	AssignedQueues              []string      `json:"assignedQueues"`
	ResultFailureCount          int           `json:"resultFailureCount"`
	InstanceName                string        `json:"instanceName"`
	RegistrationProperties      []string      `json:"registrationProperties"`
	EngineManagerNodeName       string        `json:"engineManagerNodeName"`
	MaxTransactionResultFailure int           `json:"maxTransactionResultFailure"`
	Type                        string        `json:"type"`
	BuildNumber                 int           `json:"buildNumber"`
	Platform                    string        `json:"platform"`
	ResultSuccessCount          int           `json:"resultSuccessCount"`
	MaxTransactionResultSuccess int           `json:"maxTransactionResultSuccess"`
	AssignedStreams             []interface{} `json:"assignedStreams"`
	TransactionPort             int           `json:"transactionPort"`
	CurrentJobID                int           `json:"currentJobID"`
}

type EngineV4 added in v1.2.1

type EngineV4 struct {
	Name                   string   `json:"name"`
	Hostname               string   `json:"hostname"`
	EngineManagerHostname  string   `json:"engineManagerHostname"`
	Platform               string   `json:"platform"`
	CurrentJobID           int      `json:"currentJobID"`
	BuildNumber            int      `json:"buildNumber"`
	Type                   string   `json:"type"`
	State                  string   `json:"state"`
	AssignedQueues         []string `json:"assignedQueues"`
	RegistrationProperties []string `json:"registrationProperties"`
	HostProperties         struct {
		PhysicalMemory int `json:"physicalMemory"`
		ProcessorCount int `json:"processorCount"`
	} `json:"hostProperties"`
}

type EnginesV3 added in v1.2.1

type EnginesV3 struct {
	Offset     int        `json:"offset"`
	Limit      int        `json:"limit"`
	TotalCount int        `json:"totalCount"`
	Items      []EngineV3 `json:"items"`
}

type EnginesV4 added in v1.2.1

type EnginesV4 struct {
	Offset     int        `json:"offset"`
	Limit      int        `json:"limit"`
	TotalCount int        `json:"totalCount"`
	Items      []EngineV4 `json:"items"`
}

type FMEFlowConnections added in v1.2.1

type FMEFlowConnections struct {
	Items      []Connection `json:"items"`
	TotalCount int          `json:"totalCount"`
	Limit      int          `json:"limit"`
	Offset     int          `json:"offset"`
}

type FMEFlowInfo

type FMEFlowInfo struct {
	CurrentTime       string `json:"currentTime"`
	LicenseManagement bool   `json:"licenseManagement"`
	Build             string `json:"build"`
	TimeZone          string `json:"timeZone"`
	Version           string `json:"version"`
}

type FMEFlowProjectsV3 added in v1.2.1

type FMEFlowProjectsV3 struct {
	Offset     int         `json:"offset"`
	Limit      int         `json:"limit"`
	TotalCount int         `json:"totalCount"`
	Items      []ProjectV3 `json:"items"`
}

type FMEFlowProjectsV4 added in v1.2.1

type FMEFlowProjectsV4 struct {
	Offset     int         `json:"offset"`
	Limit      int         `json:"limit"`
	TotalCount int         `json:"totalCount"`
	Items      []ProjectV4 `json:"items"`
}

type FMEFlowRepositoriesV3

type FMEFlowRepositoriesV3 struct {
	Offset     int                   `json:"offset"`
	Limit      int                   `json:"limit"`
	TotalCount int                   `json:"totalCount"`
	Items      []FMEFlowRepositoryV3 `json:"items"`
}

type FMEFlowRepositoriesV4

type FMEFlowRepositoriesV4 struct {
	Items      []FMEFlowRepositoryV4 `json:"items"`
	Limit      int                   `json:"limit"`
	Offset     int                   `json:"offset"`
	TotalCount int                   `json:"totalCount"`
}

type FMEFlowRepositoryV3

type FMEFlowRepositoryV3 struct {
	Owner       string `json:"owner"`
	Name        string `json:"name"`
	Description string `json:"description"`
	Sharable    bool   `json:"sharable"`
}

type FMEFlowRepositoryV4

type FMEFlowRepositoryV4 struct {
	CustomFormatCount      int    `json:"customFormatCount"`
	CustomTransformerCount int    `json:"customTransformerCount"`
	Description            string `json:"description"`
	FileCount              int    `json:"fileCount"`
	Name                   string `json:"name"`
	Owner                  string `json:"owner"`
	OwnerID                string `json:"ownerID"`
	Sharable               bool   `json:"sharable"`
	TemplateCount          int    `json:"templateCount"`
	TotalFileSize          int    `json:"totalFileSize"`
	WorkspaceCount         int    `json:"workspaceCount"`
}

type FMEFlowVersionInfo added in v1.2.1

type FMEFlowVersionInfo struct {
	BuildNumber   int    `json:"buildNumber"`
	BuildString   string `json:"buildString"`
	ReleaseYear   int    `json:"releaseYear"`
	MajorVersion  int    `json:"majorVersion"`
	MinorVersion  int    `json:"minorVersion"`
	HotfixVersion int    `json:"hotfixVersion"`
}

type FMEFlowWorkspaceDetailedV3

type FMEFlowWorkspaceDetailedV3 struct {
	LegalTermsConditions string  `json:"legalTermsConditions"`
	AvgCPUPct            float64 `json:"avgCpuPct"`
	Usage                string  `json:"usage"`
	AvgPeakMemUsage      int     `json:"avgPeakMemUsage"`
	Description          string  `json:"description"`
	Datasets             struct {
		Destination []struct {
			Format       string `json:"format"`
			Name         string `json:"name"`
			Location     string `json:"location"`
			Source       bool   `json:"source"`
			Featuretypes []struct {
				Name        string `json:"name"`
				Description string `json:"description"`
				Attributes  []struct {
					Decimals int    `json:"decimals"`
					Name     string `json:"name"`
					Width    int    `json:"width"`
					Type     string `json:"type"`
				} `json:"attributes"`
				Properties []interface{} `json:"properties"`
			} `json:"featuretypes"`
			Properties []struct {
				Name       string `json:"name"`
				Attributes struct {
				} `json:"attributes"`
				Category string `json:"category"`
				Value    string `json:"value"`
			} `json:"properties"`
		} `json:"destination"`
		Source []struct {
			Format       string `json:"format"`
			Name         string `json:"name"`
			Location     string `json:"location"`
			Source       bool   `json:"source"`
			Featuretypes []struct {
				Name        string `json:"name"`
				Description string `json:"description"`
				Attributes  []struct {
					Decimals int    `json:"decimals"`
					Name     string `json:"name"`
					Width    int    `json:"width"`
					Type     string `json:"type"`
				} `json:"attributes"`
				Properties []interface{} `json:"properties"`
			} `json:"featuretypes"`
			Properties []struct {
				Name       string `json:"name"`
				Attributes struct {
				} `json:"attributes"`
				Category string `json:"category"`
				Value    string `json:"value"`
			} `json:"properties"`
		} `json:"source"`
	} `json:"datasets"`
	Title           string    `json:"title"`
	Type            string    `json:"type"`
	BuildNumber     int       `json:"buildNumber"`
	Enabled         bool      `json:"enabled"`
	AvgCPUTime      int       `json:"avgCpuTime"`
	LastPublishDate time.Time `json:"lastPublishDate"`
	LastSaveBuild   string    `json:"lastSaveBuild"`
	AvgElapsedTime  int       `json:"avgElapsedTime"`
	LastSaveDate    time.Time `json:"lastSaveDate"`
	Requirements    string    `json:"requirements"`
	Resources       []struct {
		Size        int    `json:"size"`
		Name        string `json:"name"`
		Description string `json:"description"`
	} `json:"resources"`
	History  string `json:"history"`
	Services []struct {
		DisplayName string `json:"displayName"`
		Name        string `json:"name"`
	} `json:"services"`
	UserName            string        `json:"userName"`
	RequirementsKeyword string        `json:"requirementsKeyword"`
	FileSize            int           `json:"fileSize"`
	Name                string        `json:"name"`
	TotalRuns           int           `json:"totalRuns"`
	Category            string        `json:"category"`
	Parameters          []interface{} `json:"parameters"`
	Properties          []struct {
		Name       string `json:"name"`
		Attributes struct {
		} `json:"attributes"`
		Category string `json:"category"`
		Value    string `json:"value"`
	} `json:"properties"`
}

type FMEFlowWorkspaceDetailedV4

type FMEFlowWorkspaceDetailedV4 struct {
	AverageCPUPercent      float64 `json:"averageCpuPercent"`
	AverageCPUTime         float64 `json:"averageCpuTime"`
	AverageElapsedTime     float64 `json:"averageElapsedTime"`
	AveragePeakMemoryUsage int     `json:"averagePeakMemoryUsage"`
	BuildNumber            int     `json:"buildNumber"`
	Category               string  `json:"category"`
	Datasets               struct {
		Destination []struct {
			FeatureTypes []struct {
				Attributes []struct {
					Decimals int    `json:"decimals"`
					Name     string `json:"name"`
					Type     string `json:"type"`
					Width    int    `json:"width"`
				} `json:"attributes"`
				Description string `json:"description"`
				Name        string `json:"name"`
				Properties  []struct {
					Attributes struct {
						AdditionalProp1 string `json:"additionalProp1"`
						AdditionalProp2 string `json:"additionalProp2"`
						AdditionalProp3 string `json:"additionalProp3"`
					} `json:"attributes"`
					Category string `json:"category"`
					Name     string `json:"name"`
					Value    string `json:"value"`
				} `json:"properties"`
			} `json:"featureTypes"`
			Format     string `json:"format"`
			Location   string `json:"location"`
			Name       string `json:"name"`
			Properties []struct {
				Attributes struct {
					AdditionalProp1 string `json:"additionalProp1"`
					AdditionalProp2 string `json:"additionalProp2"`
					AdditionalProp3 string `json:"additionalProp3"`
				} `json:"attributes"`
				Category string `json:"category"`
				Name     string `json:"name"`
				Value    string `json:"value"`
			} `json:"properties"`
			Source bool `json:"source"`
		} `json:"destination"`
		Source []struct {
			FeatureTypes []struct {
				Attributes []struct {
					Decimals int    `json:"decimals"`
					Name     string `json:"name"`
					Type     string `json:"type"`
					Width    int    `json:"width"`
				} `json:"attributes"`
				Description string `json:"description"`
				Name        string `json:"name"`
				Properties  []struct {
					Attributes struct {
						AdditionalProp1 string `json:"additionalProp1"`
						AdditionalProp2 string `json:"additionalProp2"`
						AdditionalProp3 string `json:"additionalProp3"`
					} `json:"attributes"`
					Category string `json:"category"`
					Name     string `json:"name"`
					Value    string `json:"value"`
				} `json:"properties"`
			} `json:"featureTypes"`
			Format     string `json:"format"`
			Location   string `json:"location"`
			Name       string `json:"name"`
			Properties []struct {
				Attributes struct {
					AdditionalProp1 string `json:"additionalProp1"`
					AdditionalProp2 string `json:"additionalProp2"`
					AdditionalProp3 string `json:"additionalProp3"`
				} `json:"attributes"`
				Category string `json:"category"`
				Name     string `json:"name"`
				Value    string `json:"value"`
			} `json:"properties"`
			Source bool `json:"source"`
		} `json:"source"`
	} `json:"datasets"`
	Description          string    `json:"description"`
	Favorite             bool      `json:"favorite"`
	FileSize             int       `json:"fileSize"`
	History              string    `json:"history"`
	LastPublishDate      time.Time `json:"lastPublishDate"`
	LastSaveBuild        string    `json:"lastSaveBuild"`
	LastSaveDate         time.Time `json:"lastSaveDate"`
	LegalTermsConditions string    `json:"legalTermsConditions"`
	Name                 string    `json:"name"`
	Parameters           []struct {
		AdditionalProp1 struct {
		} `json:"additionalProp1"`
		AdditionalProp2 struct {
		} `json:"additionalProp2"`
		AdditionalProp3 struct {
		} `json:"additionalProp3"`
	} `json:"parameters"`
	Properties []struct {
		Attributes struct {
			AdditionalProp1 string `json:"additionalProp1"`
			AdditionalProp2 string `json:"additionalProp2"`
			AdditionalProp3 string `json:"additionalProp3"`
		} `json:"attributes"`
		Category string `json:"category"`
		Name     string `json:"name"`
		Value    string `json:"value"`
	} `json:"properties"`
	Requirements        string `json:"requirements"`
	RequirementsKeyword string `json:"requirementsKeyword"`
	Resources           []struct {
		Name string `json:"name"`
		Size int    `json:"size"`
	} `json:"resources"`
	Services struct {
		DataDownload struct {
			Reader     string   `json:"reader"`
			Registered bool     `json:"registered"`
			Writers    []string `json:"writers"`
			ZipLayout  struct {
				AdditionalProp1 string `json:"additionalProp1"`
				AdditionalProp2 string `json:"additionalProp2"`
				AdditionalProp3 string `json:"additionalProp3"`
			} `json:"zipLayout"`
		} `json:"dataDownload"`
		DataStreaming struct {
			Reader     string   `json:"reader"`
			Registered bool     `json:"registered"`
			Writers    []string `json:"writers"`
		} `json:"dataStreaming"`
		JobSubmitter struct {
			Reader     string `json:"reader"`
			Registered bool   `json:"registered"`
		} `json:"jobSubmitter"`
		KmlNetworkLink struct {
			Description  string `json:"description"`
			LatLonAltBox struct {
				East  int `json:"east"`
				North int `json:"north"`
				South int `json:"south"`
				West  int `json:"west"`
			} `json:"latLonAltBox"`
			Link struct {
				RefreshMode         string `json:"refreshMode"`
				ViewFormat          string `json:"viewFormat"`
				ViewRefreshInterval int    `json:"viewRefreshInterval"`
				ViewRefreshMode     string `json:"viewRefreshMode"`
				ViewRefreshTime     int    `json:"viewRefreshTime"`
			} `json:"link"`
			Lod struct {
				MaxLodPixels int `json:"maxLodPixels"`
				MinLodPixels int `json:"minLodPixels"`
			} `json:"lod"`
			Name       string   `json:"name"`
			Registered bool     `json:"registered"`
			Visibility string   `json:"visibility"`
			Writers    []string `json:"writers"`
		} `json:"kmlNetworkLink"`
	} `json:"services"`
	Title     string `json:"title"`
	TotalRuns int    `json:"totalRuns"`
	Type      string `json:"type"`
	Usage     string `json:"usage"`
	UserName  string `json:"userName"`
}

type FMEFlowWorkspaceV3

type FMEFlowWorkspaceV3 struct {
	LastSaveDate    time.Time `json:"lastSaveDate"`
	AvgCPUPct       float64   `json:"avgCpuPct"`
	AvgPeakMemUsage int       `json:"avgPeakMemUsage"`
	Description     string    `json:"description"`
	RepositoryName  string    `json:"repositoryName"`
	Title           string    `json:"title"`
	Type            string    `json:"type"`
	UserName        string    `json:"userName"`
	FileCount       int       `json:"fileCount"`
	AvgCPUTime      int       `json:"avgCpuTime"`
	LastPublishDate time.Time `json:"lastPublishDate"`
	Name            string    `json:"name"`
	TotalFileSize   int       `json:"totalFileSize"`
	TotalRuns       int       `json:"totalRuns"`
	AvgElapsedTime  int       `json:"avgElapsedTime"`
}

type FMEFlowWorkspacesV3

type FMEFlowWorkspacesV3 struct {
	Offset     int                  `json:"offset"`
	Limit      int                  `json:"limit"`
	TotalCount int                  `json:"totalCount"`
	Items      []FMEFlowWorkspaceV3 `json:"items"`
}

type FMEFlowWorkspacesV4

type FMEFlowWorkspacesV4 struct {
	Items []struct {
		AverageCPUPercent      float64   `json:"averageCpuPercent"`
		AverageCPUTime         float64   `json:"averageCpuTime"`
		AverageElapsedTime     float64   `json:"averageElapsedTime"`
		AveragePeakMemoryUsage int       `json:"averagePeakMemoryUsage"`
		Description            string    `json:"description"`
		Favorite               bool      `json:"favorite"`
		FileCount              int       `json:"fileCount"`
		LastPublishDate        time.Time `json:"lastPublishDate"`
		LastPublishUser        string    `json:"lastPublishUser"`
		LastPublishUserID      string    `json:"lastPublishUserId"`
		LastSaveDate           time.Time `json:"lastSaveDate"`
		Name                   string    `json:"name"`
		RepositoryName         string    `json:"repositoryName"`
		Title                  string    `json:"title"`
		TotalFileSize          int       `json:"totalFileSize"`
		TotalRuns              int       `json:"totalRuns"`
		Type                   string    `json:"type"`
	} `json:"items"`
	Limit      int `json:"limit"`
	Offset     int `json:"offset"`
	TotalCount int `json:"totalCount"`
}

type HealthcheckV3

type HealthcheckV3 struct {
	Status string `json:"status"`
}

type HealthcheckV4

type HealthcheckV4 struct {
	Status  string `json:"status"`
	Message string `json:"message"`
}

type JobId

type JobId struct {
	Id int `json:"id"`
}

type JobRequest

type JobRequest struct {
	PublishedParameters    []interface{}     `json:"-"`
	RawPublishedParameters []json.RawMessage `json:"publishedParameters,omitempty"`
	TMDirectives           struct {
		Rtc         bool   `json:"rtc"`
		Ttc         int    `json:"ttc,omitempty"`
		Description string `json:"description,omitempty"`
		Tag         string `json:"tag,omitempty"`
		TTL         int    `json:"ttl,omitempty"`
	} `json:"TMDirectives,omitempty"`
	NMDirectives struct {
		Directives    []Directive `json:"directives,omitempty"`
		SuccessTopics []string    `json:"successTopics,omitempty"`
		FailureTopics []string    `json:"failureTopics,omitempty"`
	} `json:"NMDirectives,omitempty"`
}

func (*JobRequest) MarshalJSON

func (f *JobRequest) MarshalJSON() ([]byte, error)

func (*JobRequest) UnmarshalJSON

func (f *JobRequest) UnmarshalJSON(b []byte) error

since the JSON for published parameters has subtypes, we need to implement this ourselves

type JobResult

type JobResult struct {
	TimeRequested       time.Time `json:"timeRequested"`
	RequesterResultPort int       `json:"requesterResultPort"`
	NumFeaturesOutput   int       `json:"numFeaturesOutput"`
	RequesterHost       string    `json:"requesterHost"`
	TimeStarted         time.Time `json:"timeStarted"`
	ID                  int       `json:"id"`
	TimeFinished        time.Time `json:"timeFinished"`
	Priority            int       `json:"priority"`
	StatusMessage       string    `json:"statusMessage"`
	Status              string    `json:"status"`
}

type JobStatusV3 added in v1.2.1

type JobStatusV3 struct {
	Request       JobRequest `json:"request"`
	TimeDelivered time.Time  `json:"timeDelivered"`
	Workspace     string     `json:"workspace"`
	NumErrors     int        `json:"numErrors"`
	NumLines      int        `json:"numLines"`
	EngineHost    string     `json:"engineHost"`
	TimeQueued    time.Time  `json:"timeQueued"`
	CPUPct        float64    `json:"cpuPct"`
	Description   string     `json:"description"`
	TimeStarted   time.Time  `json:"timeStarted"`
	Repository    string     `json:"repository"`
	UserName      string     `json:"userName"`
	Result        JobResult  `json:"result"`
	CPUTime       int        `json:"cpuTime"`
	ID            int        `json:"id"`
	TimeFinished  time.Time  `json:"timeFinished"`
	EngineName    string     `json:"engineName"`
	NumWarnings   int        `json:"numWarnings"`
	TimeSubmitted time.Time  `json:"timeSubmitted"`
	ElapsedTime   int        `json:"elapsedTime"`
	PeakMemUsage  int        `json:"peakMemUsage"`
	Status        string     `json:"status"`
}

type JobStatusV4 added in v1.2.1

type JobStatusV4 struct {
	ID                       int       `json:"id"`
	Description              string    `json:"description"`
	EngineHost               string    `json:"engineHost"`
	EngineName               string    `json:"engineName"`
	Repository               string    `json:"repository"`
	Queue                    string    `json:"queue"`
	QueueType                string    `json:"queueType"`
	ResultDatasetDownloadURL string    `json:"resultDatasetDownloadUrl"`
	Status                   string    `json:"status"`
	TimeFinished             time.Time `json:"timeFinished"`
	TimeQueued               time.Time `json:"timeQueued"`
	TimeStarted              time.Time `json:"timeStarted"`
	RuntimeUsername          string    `json:"runtimeUsername"`
	RuntimeUserID            string    `json:"runtimeUserID"`
	Workspace                string    `json:"workspace"`
	ElapsedTime              int       `json:"elapsedTime"`
	CPUTime                  int       `json:"cpuTime"`
	CPUPercent               float64   `json:"cpuPercent"`
	PeakMemoryUsage          int       `json:"peakMemoryUsage"`
	LineCount                int       `json:"lineCount"`
	WarningCount             int       `json:"warningCount"`
	ErrorCount               int       `json:"errorCount"`
}

type JobsV3 added in v1.2.1

type JobsV3 struct {
	Offset     int           `json:"offset"`
	Limit      int           `json:"limit"`
	TotalCount int           `json:"totalCount"`
	Items      []JobStatusV3 `json:"items"`
}

type JobsV4 added in v1.2.1

type JobsV4 struct {
	Offset     int           `json:"offset"`
	Limit      int           `json:"limit"`
	TotalCount int           `json:"totalCount"`
	Items      []JobStatusV4 `json:"items"`
}

type LicenseRequestV4 added in v1.3.1

type LicenseRequestV4 struct {
	JobTitle           string `json:"jobTitle,omitempty"`
	Company            string `json:"company,omitempty"`
	Industry           string `json:"industry,omitempty"`
	Email              string `json:"email"`
	FirstName          string `json:"firstName"`
	LastName           string `json:"lastName"`
	SerialNumber       string `json:"serialNumber,omitempty"`
	SubscribeToUpdates bool   `json:"subscribeToUpdates"`
}

v4 request structure

type LicenseStatusV3 added in v1.3.1

type LicenseStatusV3 struct {
	ExpiryDate       string `json:"expiryDate"`
	MaximumEngines   int    `json:"maximumEngines"`
	SerialNumber     string `json:"serialNumber"`
	IsLicenseExpired bool   `json:"isLicenseExpired"`
	IsLicensed       bool   `json:"isLicensed"`
	MaximumAuthors   int    `json:"maximumAuthors"`
}

type LicenseStatusV4 added in v1.3.1

type LicenseStatusV4 struct {
	Licensed       bool   `json:"licensed"`
	Expiration     string `json:"expiration"`
	MaximumEngines int    `json:"maximumEngines"`
	Expired        bool   `json:"expired"`
	SerialNumber   string `json:"serialNumber"`
	MaximumAuthors int    `json:"maximumAuthors"`
}

type ListParameter

type ListParameter struct {
	Value []string `json:"value"`
	PublishedParameter
}

type MachineKey

type MachineKey struct {
	MachineKey string `json:"machineKey"`
}

type Message

type Message struct {
	Message string `json:"message"`
}

type MutableProjectItemNameV3 added in v1.2.1

type MutableProjectItemNameV3 struct {
	Name string `json:"name"`
	UUID string `json:"uuid"`
}

type NewConnection added in v1.2.1

type NewConnection struct {
	Category             string                 `json:"category"`
	Name                 string                 `json:"name"`
	Type                 string                 `json:"type"`
	AuthenticationMethod string                 `json:"authenticationMethod,omitempty"`
	Username             string                 `json:"username"`
	Password             string                 `json:"password"`
	Parameters           map[string]interface{} `json:"parameters,omitempty"`
}

type NewDeploymentParameter added in v1.2.1

type NewDeploymentParameter struct {
	Name           string `json:"name"`
	Type           string `json:"type"`
	Value          string `json:"value"`
	ChoiceSettings struct {
		ChoiceSet        string   `json:"choiceSet"`
		Services         []string `json:"services,omitempty"`
		ExcludedServices []string `json:"excludedServices,omitempty"`
		Family           string   `json:"family,omitempty"`
	} `json:"choiceSettings,omitempty"`
}

type NewRepository

type NewRepository struct {
	Description string `json:"description"`
	Name        string `json:"name"`
}

type ProjectImportRun added in v1.2.1

type ProjectImportRun struct {
	FallbackOwnerID    string                 `json:"fallbackOwnerID,omitempty"`
	Overwrite          bool                   `json:"overwrite"`
	PauseNotifications bool                   `json:"pauseNotifications"`
	DisableItems       bool                   `json:"disableItems"`
	Notification       *ProjectNotification   `json:"notification,omitempty"`
	SelectedItems      []ProjectSelectedItems `json:"selectedItems"`
}

type ProjectItemDependencyV4 added in v1.2.1

type ProjectItemDependencyV4 struct {
	Name         string   `json:"name"`
	ID           string   `json:"id"`
	Type         string   `json:"type"`
	Dependencies []string `json:"dependencies"`
}

type ProjectItemV3 added in v1.2.1

type ProjectItemV3 struct {
	Name string `json:"name"`
}

type ProjectItemV4 added in v1.2.1

type ProjectItemV4 struct {
	ID           string                    `json:"id"`
	Name         string                    `json:"name"`
	Type         string                    `json:"type"`
	Owner        string                    `json:"owner"`
	LastUpdated  time.Time                 `json:"lastUpdated"`
	Dependencies []ProjectItemDependencyV4 `json:"dependencies"`
}

type ProjectItems added in v1.2.1

type ProjectItems struct {
	Items      []ProjectUploadItemV4 `json:"items"`
	TotalCount int                   `json:"totalCount"`
	Limit      int                   `json:"limit"`
	Offset     int                   `json:"offset"`
}

type ProjectItemsV4 added in v1.2.1

type ProjectItemsV4 struct {
	Items      []ProjectItemV4 `json:"items"`
	TotalCount int             `json:"totalCount"`
	Limit      int             `json:"limit"`
	Offset     int             `json:"offset"`
}

type ProjectNotification added in v1.2.1

type ProjectNotification struct {
	Type         string `json:"type,omitempty"`
	SuccessTopic string `json:"successTopic,omitempty"`
	FailureTopic string `json:"failureTopic,omitempty"`
}

type ProjectSelectedItems added in v1.2.1

type ProjectSelectedItems struct {
	Type string `json:"type"`
	ID   string `json:"id"`
}

type ProjectTaskV4 added in v1.2.1

type ProjectTaskV4 struct {
	ID                   int       `json:"id"`
	Type                 string    `json:"type"`
	Username             string    `json:"username"`
	StartDate            time.Time `json:"startDate"`
	FinishedDate         time.Time `json:"finishedDate"`
	Status               string    `json:"status"`
	ProjectName          any       `json:"projectName"`
	SuccessTopic         string    `json:"successTopic"`
	FailureTopic         string    `json:"failureTopic"`
	ResourceName         string    `json:"resourceName"`
	PackagePath          string    `json:"packagePath"`
	PackageName          string    `json:"packageName"`
	ImportMode           string    `json:"importMode"`
	ProjectsImportMode   string    `json:"projectsImportMode"`
	PauseNotifications   bool      `json:"pauseNotifications"`
	Result               string    `json:"result"`
	ExcludeSensitiveInfo bool      `json:"excludeSensitiveInfo"`
	DisableProjectItems  bool      `json:"disableProjectItems"`
}

type ProjectUploadItemV4 added in v1.2.1

type ProjectUploadItemV4 struct {
	ID            string `json:"id"`
	JobID         int    `json:"jobId"`
	Name          string `json:"name"`
	Type          string `json:"type"`
	OwnerID       string `json:"ownerId"`
	OwnerName     string `json:"ownerName"`
	OwnerStatus   string `json:"ownerStatus"`
	OriginalOwner string `json:"originalOwner"`
	Selected      bool   `json:"selected"`
	Existing      bool   `json:"existing"`
	PreviewAction string `json:"previewAction"`
	Action        string `json:"action"`
	Source        string `json:"source"`
}

type ProjectUploadTask

type ProjectUploadTask struct {
	Id int `json:"id"`
}

type ProjectUploadV4 added in v1.2.1

type ProjectUploadV4 struct {
	JobID     int              `json:"jobId"`
	Status    string           `json:"status"`
	Owner     string           `json:"owner"`
	OwnerID   string           `json:"ownerID"`
	Requested time.Time        `json:"requested"`
	Generated time.Time        `json:"generated"`
	FileName  string           `json:"fileName"`
	Request   ProjectImportRun `json:"request"`
}

type ProjectV3 added in v1.2.1

type ProjectV3 struct {
	Owner              string                     `json:"owner"`
	UID                string                     `json:"uid"`
	LastSaveDate       time.Time                  `json:"lastSaveDate"`
	HasIcon            bool                       `json:"hasIcon"`
	Name               string                     `json:"name"`
	Description        string                     `json:"description"`
	Sharable           bool                       `json:"sharable"`
	Readme             string                     `json:"readme"`
	UserName           string                     `json:"userName"`
	Version            string                     `json:"version"`
	FmeHubPublisherUID string                     `json:"fmeHubPublisherUid"`
	Accounts           []ProjectItemV3            `json:"accounts"`
	AppSuites          []ProjectItemV3            `json:"appSuites"`
	Apps               []ProjectItemV3            `json:"apps"`
	AutomationApps     []MutableProjectItemNameV3 `json:"automationApps"`
	Automations        []MutableProjectItemNameV3 `json:"automations"`
	CleanupTasks       []struct {
		Category string `json:"category"`
		Name     string `json:"name"`
	}
	Connections         []ProjectItemV3      `json:"connections"`
	CustomFormats       []RepositoryItemV3   `json:"customFormats"`
	CustomTransformers  []RepositoryItemV3   `json:"customTransformers"`
	Projects            []ProjectItemV3      `json:"projects"`
	Publications        []ProjectItemV3      `json:"publications"`
	Repositories        []ProjectItemV3      `json:"repositories"`
	ResourceConnections []ProjectItemV3      `json:"resourceConnections"`
	ResourcePaths       []ResourcePathItemV3 `json:"resourcePaths"`
	Roles               []ProjectItemV3      `json:"roles"`
	Schedules           []struct {
		Name     string `json:"name"`
		Category string `json:"category"`
	}
	Streams       []MutableProjectItemNameV3 `json:"streams"`
	Subscriptions []ProjectItemV3            `json:"subscriptions"`
	Templates     []RepositoryItemV3         `json:"templates"`
	Tokens        []struct {
		Name     string `json:"name"`
		UserName string `json:"userName"`
	}
	Topics     []ProjectItemV3    `json:"topics"`
	Workspaces []RepositoryItemV3 `json:"workspaces"`
}

type ProjectV4 added in v1.2.1

type ProjectV4 struct {
	ID               string    `json:"id"`
	Name             string    `json:"name"`
	HubUID           string    `json:"hubUid"`
	HubPublisherUID  string    `json:"hubPublisherUid"`
	Description      string    `json:"description"`
	Readme           string    `json:"readme"`
	Version          string    `json:"version"`
	LastUpdated      time.Time `json:"lastUpdated"`
	Owner            string    `json:"owner"`
	OwnerID          string    `json:"ownerID"`
	Shareable        bool      `json:"shareable"`
	LastUpdateUser   string    `json:"lastUpdateUser"`
	LastUpdateUserID string    `json:"lastUpdateUserID"`
	HasIcon          bool      `json:"hasIcon"`
}

type ProjectsResource

type ProjectsResource struct {
	Id int `json:"id"`
}

type PublishedParameter

type PublishedParameter struct {
	Name string `json:"name"`
}

type RefreshStatus

type RefreshStatus struct {
	Status  string `json:"status"`
	Message string `json:"message"`
}

type RepositoryItemV3 added in v1.2.1

type RepositoryItemV3 struct {
	Name           string `json:"name"`
	RepositoryName string `json:"repositoryName"`
}

type RequestStatusV3 added in v1.3.1

type RequestStatusV3 struct {
	Status  string `json:"status"`
	Message string `json:"message"`
}

v3 response structure

type RequestStatusV4 added in v1.3.1

type RequestStatusV4 struct {
	Status  string `json:"status"`
	Message string `json:"message"`
}

v4 response structure

type ResourcePathItemV3 added in v1.2.1

type ResourcePathItemV3 struct {
	Name string `json:"name"`
	Path string `json:"path"`
}

type RestoreResource

type RestoreResource struct {
	Id int `json:"id"`
}

type SimpleParameter

type SimpleParameter struct {
	Value string `json:"value"`
	PublishedParameter
}

type SystemCode

type SystemCode struct {
	SystemCode string `json:"systemCode"`
}

type TokenRequestV3 added in v1.2.1

type TokenRequestV3 struct {
	Restricted        bool   `json:"restricted"`
	Name              string `json:"name"`
	Description       string `json:"description"`
	ExpirationTimeout int    `json:"expirationTimeout"`
	User              string `json:"user"`
	Enabled           bool   `json:"enabled"`
}

type TokenRequestV4 added in v1.2.1

type TokenRequestV4 struct {
	Name              string `json:"name"`
	Description       string `json:"description"`
	Enabled           bool   `json:"enabled"`
	CustomPermissions bool   `json:"customPermissions"`
	SecondsToExpiry   int    `json:"secondsToExpiry"`
}

type TokenResponseV3 added in v1.2.1

type TokenResponseV3 struct {
	LastSaveDate   time.Time `json:"lastSaveDate"`
	CreatedDate    time.Time `json:"createdDate"`
	Restricted     bool      `json:"restricted"`
	Name           string    `json:"name"`
	Description    string    `json:"description"`
	Type           string    `json:"type"`
	User           string    `json:"user"`
	Enabled        bool      `json:"enabled"`
	ExpirationDate time.Time `json:"expirationDate"`
	Token          string    `json:"token"`
}

type TokenResponseV4 added in v1.2.1

type TokenResponseV4 struct {
	Name              string    `json:"name"`
	Description       string    `json:"description"`
	Owner             string    `json:"owner"`
	Type              string    `json:"type"`
	CustomPermissions bool      `json:"customPermissions"`
	Enabled           bool      `json:"enabled"`
	Created           time.Time `json:"created"`
	Updated           time.Time `json:"updated"`
	SecondsToExpiry   int       `json:"secondsToExpiry"`
	Expiration        time.Time `json:"expiration"`
	Token             string    `json:"token"`
}

type UpdateConnection added in v1.2.1

type UpdateConnection struct {
	Category             string                 `json:"category"`
	AuthenticationMethod string                 `json:"authenticationMethod,omitempty"`
	Username             string                 `json:"username"`
	Password             string                 `json:"password"`
	Parameters           map[string]interface{} `json:"parameters,omitempty"`
}

type UpdateDeploymentParameter added in v1.2.1

type UpdateDeploymentParameter struct {
	Type           string          `json:"type,omitempty"`
	Value          string          `json:"value"`
	ChoiceSettings *ChoiceSettings `json:"choiceSettings,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL