models

Documentation

Overview

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License.

Index

• type AccessSummary
• type ApplicationSpec
• type ApplicationSummary
• type BrooklynFeatureSummary
• type CatalogBundleAddResult
• type CatalogEntitySummary
  • func (summary *CatalogEntitySummary) Display(c *cli.Context) error
• type CatalogItemSummary
  • func (summary *CatalogItemSummary) Display(c *cli.Context) error
• type ConfigSummary
• type EffectorSummary
• type EntitySummary
• type IdentityDetails
• type LinkStreamMetadata
• type LinkStreamsWithMetadata
• type LinkTaskMetadata
• type LinkTaskWithMetadata
• type LinkWithMetadata
• type LocationSummary
• type MemberSpec
• type ParameterSummary
• type PolicyConfigList
• type PolicySummary
• type SensorSummary
• type Status
• type TaskSummary
• type Tree
• type URI
• type VersionSummary

Types

type AccessSummary

type AccessSummary struct {
	Links                       map[string]URI `json:"links"`
	LocationProvisioningAllowed bool           `json:"locationProvisioningAllowed"`
}

type ApplicationSpec

type ApplicationSpec struct {
	Name      string   `json:"name"`
	Type      string   `json:"type"`
	Locations []string `json:"locations"`
}

type ApplicationSummary

type ApplicationSummary struct {
	Links  map[string]URI  `json:"links"`
	Id     string          `json:"id"`
	Spec   ApplicationSpec `json:"spec"`
	Status Status          `json:"status"`
}

type BrooklynFeatureSummary

type BrooklynFeatureSummary struct {
	Name           string            `json:"name"`
	SymbolicName   string            `json:"symbolicName"`
	Version        string            `json:"version"`
	LastModified   string            `json:"lastModified"`
	AdditionalData map[string]string `json:"additionalData"`
}

type CatalogBundleAddResult

type CatalogBundleAddResult struct {
	Message string                        `json:"message"`
	Bundle  string                        `json:"bundle"`
	Code    string                        `json:"code"`
	Types   map[string]CatalogItemSummary `json:"types"`
}

type CatalogEntitySummary

type CatalogEntitySummary struct {
	CatalogItemSummary
	IconUrl   string            `json:"iconUrl"`
	Effectors []EffectorSummary `json:"effectors"`
	Sensors   []SensorSummary   `json:"sensors"`
}

func (*CatalogEntitySummary) Display

func (summary *CatalogEntitySummary) Display(c *cli.Context) error

type CatalogItemSummary

type CatalogItemSummary struct {
	IdentityDetails
	JavaType   string                 `json:"javaType"`
	PlanYaml   string                 `json:"planYaml"`
	Deprecated bool                   `json:"deprecated"`
	Config     []ConfigSummary        `json:"config"`
	Tags       []interface{}          `json:"tags"`
	Links      map[string]interface{} `json:"links"`
	Type       string                 `json:"type"`
}

func (*CatalogItemSummary) Display

func (summary *CatalogItemSummary) Display(c *cli.Context) error

type ConfigSummary

type ConfigSummary struct {
	Reconfigurable bool                `json:"reconfigurable"`
	PossibleValues []map[string]string `json:"possibleValues"`
	DefaultValue   interface{}         `json:"defaultValue"`
	Name           string              `json:"name"`
	Description    string              `json:"description"`
	Links          map[string]URI      `json:"links"`
	Label          string              `json:"label"`
	Priority       float64             `json:"priority"`
	Pinned         bool                `json:"pinned"`
	Type           string              `json:"type"`
}

type EffectorSummary

type EffectorSummary struct {
	Name        string             `json:"name"`
	Description string             `json:"description"`
	Links       map[string]URI     `json:"links"`
	Parameters  []ParameterSummary `json:"parameters"`
	ReturnType  string             `json:"returnType"`
}

type EntitySummary

type EntitySummary struct {
	CatalogItemId string         `json:"catalogItemId"`
	Name          string         `json:"name"`
	Links         map[string]URI `json:"links"`
	Id            string         `json:"id"`
	Type          string         `json:"type"`
}

type IdentityDetails

type IdentityDetails struct {
	Id           string `json:"id"`
	Name         string `json:"name"`
	SymbolicName string `json:"symbolicName"`
	Version      string `json:"version"`
	Description  string `json:"description"`
}

type LinkStreamMetadata

type LinkStreamMetadata struct {
	Name     string `json:"name"`
	Size     int64  `json:"size"`
	SizeText string `json:"sizeText"`
}

type LinkStreamsWithMetadata

type LinkStreamsWithMetadata struct {
	Link     string             `json:"link"`
	Metadata LinkStreamMetadata `json:"metadata"`
}

type LinkTaskMetadata

type LinkTaskMetadata struct {
	Id                string `json:"id"`
	TaskName          string `json:"taskName"`
	EntityId          string `json:"entityId"`
	EntityDisplayName string `json:"entityDisplayName"`
}

type LinkTaskWithMetadata

type LinkTaskWithMetadata struct {
	Link     string           `json:"link"`
	Metadata LinkTaskMetadata `json:"metadata"`
}

type LinkWithMetadata

type LinkWithMetadata struct {
}

type LocationSummary

type LocationSummary struct {
	Id     string                 `json:"id"`
	Name   string                 `json:"name"`
	Spec   string                 `json:"spec"`
	Type   string                 `json:"type"`
	Config map[string]interface{} `json:"config"`
	Links  map[string]URI         `json:"links"`
}

type MemberSpec

type MemberSpec struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

type ParameterSummary

type ParameterSummary struct {
	Name         string      `json:"name"`
	Type         string      `json:"type"`
	Description  string      `json:"description"`
	DefaultValue interface{} `json:"defaultValue"`
}

type PolicyConfigList

type PolicyConfigList struct {
	Name           string         `json:"name"`
	Type           string         `json:"type"`
	DefaultValue   interface{}    `json:"defaultValue`
	Description    string         `json:"description"`
	Reconfigurable bool           `json:"reconfigurable"`
	Label          string         `json:"label"`
	Priority       int64          `json:"priority"`
	PossibleValues []interface{}  `json:"possibleValues"`
	Links          map[string]URI `json:"links"`
}

type PolicySummary

type PolicySummary struct {
	CatalogItemId string         `json:"catalogItemId"`
	Name          string         `json:"name"`
	Links         map[string]URI `json:"links"`
	Id            string         `json:"id"`
	State         Status         `json:"state"`
}

type SensorSummary

type SensorSummary struct {
	Name        string         `json:"name"`
	Description string         `json:"description"`
	Links       map[string]URI `json:"links"`
	Type        string         `json:"type"`
}

type Status

type Status string

type TaskSummary

type TaskSummary struct {
	SubmitTimeUtc     int64                              `json:"submitTimeUtc"`
	EndTimeUtc        int64                              `json:"endTimeUtc"`
	IsCancelled       bool                               `json:"isCancelled"`
	CurrentStatus     string                             `json:"currentStatus"`
	BlockingTask      LinkTaskWithMetadata               `json:"blockingTask"`
	DisplayName       string                             `json:"displayName"`
	Streams           map[string]LinkStreamsWithMetadata `json:"streams"`
	Description       string                             `json:"description"`
	EntityId          string                             `json:"entityId"`
	EntityDisplayName string                             `json:"entityDisplayName"`
	Error             bool                               `json:"error"`
	SubmittedByTask   LinkTaskWithMetadata               `json:"submittedByTask"`
	Result            interface{}                        `json:"result"`
	IsError           bool                               `json:"isError"`
	DetailedStatus    string                             `json:"detailedStatus"`
	Children          []LinkTaskWithMetadata             `json:"children"`
	BlockingDetails   string                             `json:"blockingDetails"`
	Cancelled         bool                               `json:"cancelled"`
	Links             map[string]URI                     `json:"links"`
	Id                string                             `json:"id"`
	StartTimeUtc      int64                              `json:"startTimeUtc"`
}

type Tree

type Tree struct {
	Id            string       `json:"id"`
	ParentId      string       `json:"parentId"`
	Name          string       `json:"name"`
	Type          string       `json:"type"`
	CatalogItemId string       `json:"catalogItemId"`
	Children      []Tree       `json:"children"`
	GroupIds      []string     `json:"groupIds"`
	Members       []MemberSpec `json:"members"`
}

type URI

type URI string

type VersionSummary

type VersionSummary struct {
	Version     string                   `json:"version"`
	BuildSha1   string                   `json:"buildSha1"`
	BuildBranch string                   `json:"buildBranch"`
	Features    []BrooklynFeatureSummary `json:"features"`
}