cmgr

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Jul 13, 2025 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Platform = "PLATFORM"
	Access   = "ACCESS"
)

Possible pool types

View Source 
const (
	PlatformConnector = "PLATFORM_CONNECTOR"
	AccessConnector   = "ACCESS_CONNECTOR"
)

Possible values for the Type field in ArkCmgrPoolComponent

View Source 
const (
	GeneralFQDN       = "GENERAL_FQDN"
	GeneralHostname   = "GENERAL_HOSTNAME"
	AWSAccountID      = "AWS_ACCOUNT_ID"
	AWSVPC            = "AWS_VPC"
	AWSSubnet         = "AWS_SUBNET"
	AzureSubscription = "AZURE_SUBSCRIPTION"
	AzureVNet         = "AZURE_VNET"
	AzureSubnet       = "AZURE_SUBNET"
	GCPProject        = "GCP_PROJECT"
	GCPNetwork        = "GCP_NETWORK"
	GCPSubnet         = "GCP_SUBNET"
)

Possible values for the identifier type in ArkCmgrPoolIdentifier

Variables

This section is empty.

Functions

This section is empty.

Types

type ArkCmgrAddNetwork 

type ArkCmgrAddNetwork struct {
	Name string `json:"name" mapstructure:"name" flag:"name" desc:"Name of the network to add" required:"true"`
}

ArkCmgrAddNetwork is a struct representing the filter for adding a network in the Ark CMGR service.

type ArkCmgrAddPool 

type ArkCmgrAddPool struct {
	Name               string   `json:"name" mapstructure:"name" flag:"name" desc:"Name of the pool to add" required:"true"`
	Description        string   `json:"description,omitempty" mapstructure:"description,omitempty" flag:"description" desc:"Pool description"`
	AssignedNetworkIDs []string `` /* 128-byte string literal not displayed */
}

ArkCmgrAddPool is a struct representing the filter for adding a pool in the Ark CMGR service.

type ArkCmgrAddPoolBulkIdentifier 

type ArkCmgrAddPoolBulkIdentifier struct {
	PoolID      string                     `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to add the identifiers to"`
	Identifiers []ArkCmgrAddPoolIdentifier `json:"identifiers" mapstructure:"identifiers" flag:"identifiers" desc:"Identifiers to add"`
}

ArkCmgrAddPoolBulkIdentifier is a struct representing the filter for adding multiple identifiers to a pool in the Ark CMGR service.

type ArkCmgrAddPoolIdentifier 

type ArkCmgrAddPoolIdentifier struct {
	Type  string `` /* 376-byte string literal not displayed */
	Value string `json:"value" mapstructure:"value" flag:"value" desc:"Value of the identifier"`
}

ArkCmgrAddPoolIdentifier is a struct representing the filter for adding identifiers to a pool in the Ark CMGR service.

type ArkCmgrAddPoolSingleIdentifier 

type ArkCmgrAddPoolSingleIdentifier struct {
	Type   string `` /* 376-byte string literal not displayed */
	Value  string `json:"value" mapstructure:"value" flag:"value" desc:"Value of the identifier"`
	PoolID string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to add the identifier to"`
}

ArkCmgrAddPoolSingleIdentifier is a struct representing the filter for adding a single identifier to a pool in the Ark CMGR service.

type ArkCmgrBulkResponse 

type ArkCmgrBulkResponse struct {
	Body       map[string]interface{} `json:"body,omitempty" mapstructure:"body,omitempty" flag:"body" desc:"Response body of the request"`
	StatusCode int                    `json:"status_code" mapstructure:"status_code" flag:"status-code" desc:"Status code of the response"`
}

ArkCmgrBulkResponse is a struct representing the response of a bulk request in the Ark CMGR service.

type ArkCmgrBulkResponses 

type ArkCmgrBulkResponses struct {
	Responses map[string]ArkCmgrBulkResponse `json:"responses" mapstructure:"responses" flag:"responses" desc:"Responses of the bulk request"`
}

ArkCmgrBulkResponses is a struct representing the responses of a bulk request in the Ark CMGR service.

type ArkCmgrDeleteNetwork 

type ArkCmgrDeleteNetwork struct {
	NetworkID string `json:"network_id" mapstructure:"network_id" flag:"network-id" desc:"ID of the network to delete"`
}

ArkCmgrDeleteNetwork is a struct representing the filter for deleting a network in the Ark CMGR service.

type ArkCmgrDeletePool 

type ArkCmgrDeletePool struct {
	PoolID string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to delete"`
}

ArkCmgrDeletePool is a struct representing the filter for deleting a specific pool in the Ark CMGR service.

type ArkCmgrDeletePoolBulkIdentifier 

type ArkCmgrDeletePoolBulkIdentifier struct {
	PoolID      string                        `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to delete the identifiers from"`
	Identifiers []ArkCmgrDeletePoolIdentifier `json:"identifiers" mapstructure:"identifiers" flag:"identifiers" desc:"Identifiers to delete"`
}

ArkCmgrDeletePoolBulkIdentifier is a struct representing the filter for deleting multiple identifiers from a pool in the Ark CMGR service.

type ArkCmgrDeletePoolIdentifier 

type ArkCmgrDeletePoolIdentifier struct {
	IdentifierID string `json:"identifier_id" mapstructure:"identifier_id" flag:"identifier-id" desc:"ID of the identifier to delete"`
}

ArkCmgrDeletePoolIdentifier is a struct representing the filter for deleting a specific identifier from a pool in the Ark CMGR service.

type ArkCmgrDeletePoolSingleIdentifier 

type ArkCmgrDeletePoolSingleIdentifier struct {
	IdentifierID string `json:"identifier_id" mapstructure:"identifier_id" flag:"identifier-id" desc:"ID of the identifier to delete"`
	PoolID       string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to delete the identifier from"`
}

ArkCmgrDeletePoolSingleIdentifier is a struct representing the filter for deleting a single identifier from a pool in the Ark CMGR service.

type ArkCmgrGetNetwork 

type ArkCmgrGetNetwork struct {
	NetworkID string `json:"network_id" mapstructure:"network_id" flag:"network-id" desc:"ID of the network to get"`
}

ArkCmgrGetNetwork is a struct representing the filter for getting a specific network in the Ark CMGR service.

type ArkCmgrGetPool 

type ArkCmgrGetPool struct {
	PoolID string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to get"`
}

ArkCmgrGetPool is a struct representing the filter for getting a specific pool in the Ark CMGR service.

type ArkCmgrGetPoolComponent 

type ArkCmgrGetPoolComponent struct {
	PoolID      string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to get"`
	ComponentID string `json:"component_id" mapstructure:"component_id" flag:"component-id" desc:"ID of the component to get in the pool"`
}

ArkCmgrGetPoolComponent is a struct representing the filter for getting a specific component in a pool in the Ark CMGR service.

type ArkCmgrGetPoolIdentifier 

type ArkCmgrGetPoolIdentifier struct {
	IdentifierID string `json:"identifier_id" mapstructure:"identifier_id" flag:"identifier-id" desc:"ID of the identifier to get from the pool"`
	PoolID       string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to get"`
}

ArkCmgrGetPoolIdentifier is a struct representing the filter for getting a specific component in a pool in the Ark CMGR service.

type ArkCmgrListPoolIdentifiers 

type ArkCmgrListPoolIdentifiers struct {
	PoolID string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"Pool id to get the identifiers for"`
}

ArkCmgrListPoolIdentifiers is a struct representing the filter for listing pool identifiers in the Ark CMGR service.

type ArkCmgrNetwork 

type ArkCmgrNetwork struct {
	NetworkID     string               `json:"network_id" mapstructure:"network_id" flag:"network-id" desc:"ID of the network"`
	Name          string               `json:"name" mapstructure:"name" flag:"name" desc:"Name of the network"`
	AssignedPools []ArkCmgrNetworkPool `` /* 131-byte string literal not displayed */
	CreatedAt     string               `json:"created_at" mapstructure:"created_at" flag:"created-at" desc:"The creation time of the network"`
	UpdatedAt     string               `json:"updated_at" mapstructure:"updated_at" flag:"updated-at" desc:"The last update time of the network"`
}

ArkCmgrNetwork is a struct representing a network in the Ark CMGR service.

type ArkCmgrNetworkPool 

type ArkCmgrNetworkPool struct {
	PoolID string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool"`
	Name   string `json:"name" mapstructure:"name" flag:"name" desc:"Name of the pool"`
}

ArkCmgrNetworkPool is a struct representing a network pool in the Ark CMGR service.

type ArkCmgrNetworksFilter 

type ArkCmgrNetworksFilter struct {
	ArkCmgrPoolsCommonFilter
}

ArkCmgrNetworksFilter is a struct representing the filter for networks in the Ark CMGR service.

type ArkCmgrNetworksStats 

type ArkCmgrNetworksStats struct {
	NetworksCount        int            `json:"networks_count" mapstructure:"networks_count" flag:"networks-count" desc:"Overall count of network"`
	PoolsCountPerNetwork map[string]int `` /* 139-byte string literal not displayed */
}

ArkCmgrNetworksStats is a struct representing the statistics of networks in the Ark CMGR service.

type ArkCmgrPool 

type ArkCmgrPool struct {
	PoolID             string         `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool"`
	Name               string         `json:"name" mapstructure:"name" flag:"name" desc:"Name of the pool"`
	Description        string         `json:"description,omitempty" mapstructure:"description,omitempty" flag:"description" desc:"Description of the pool"`
	AssignedNetworkIDs []string       `` /* 128-byte string literal not displayed */
	IdentifiersCount   int            `` /* 142-byte string literal not displayed */
	ComponentsCount    map[string]int `` /* 138-byte string literal not displayed */
	CreatedAt          string         `json:"created_at" mapstructure:"created_at" flag:"created-at" desc:"The creation time of the pool"`
	UpdatedAt          string         `json:"updated_at" mapstructure:"updated_at" flag:"updated-at" desc:"The last update time of the pool"`
}

ArkCmgrPool is a struct representing a pool in the Ark CMGR service.

type ArkCmgrPoolComponent 

type ArkCmgrPoolComponent struct {
	ComponentID string `json:"component_id" mapstructure:"component_id" flag:"component-id" desc:"ID of the component"`
	Type        string `json:"type" mapstructure:"type" flag:"type" desc:"Type of the component" choices:"PLATFORM_CONNECTOR,ACCESS_CONNECTOR"`
	ExternalID  string `json:"external_id" mapstructure:"external_id" flag:"external-id" desc:"External identifier of the component"`
	PoolID      string `json:"pool_id,omitempty" mapstructure:"pool_id,omitempty" flag:"pool-id" desc:"Pool id of the pool holding the component"`
	PoolName    string `json:"pool_name,omitempty" mapstructure:"pool_name,omitempty" flag:"pool-name" desc:"Name of the pool holding the component"`
	CreatedAt   string `json:"created_at,omitempty" mapstructure:"created_at,omitempty" flag:"created-at" desc:"The creation time of the component"`
	UpdatedAt   string `` /* 126-byte string literal not displayed */
}

ArkCmgrPoolComponent is a struct representing a component in the Ark CMGR service.

type ArkCmgrPoolComponentsFilter 

type ArkCmgrPoolComponentsFilter struct {
	ArkCmgrPoolsCommonFilter
}

ArkCmgrPoolComponentsFilter is a struct representing the filter for pool components in the Ark CMGR service.

type ArkCmgrPoolIdentifier 

type ArkCmgrPoolIdentifier struct {
	IdentifierID string `json:"identifier_id" mapstructure:"identifier_id" flag:"identifier-id" desc:"ID of the identifier"`
	PoolID       string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool this identifier is associated to"`
	Type         string `` /* 369-byte string literal not displayed */
	Value        string `json:"value" mapstructure:"value" flag:"value" desc:"Value of the identifier"`
	CreatedAt    string `json:"created_at" mapstructure:"created_at" flag:"created-at" desc:"The creation time of the identifier"`
	UpdatedAt    string `json:"updated_at" mapstructure:"updated_at" flag:"updated-at" desc:"The last update time of the identifier"`
}

ArkCmgrPoolIdentifier is a struct representing an identifier for a pool in the Ark CMGR service.

type ArkCmgrPoolIdentifiers 

type ArkCmgrPoolIdentifiers struct {
	Identifiers []*ArkCmgrPoolIdentifier `json:"identifiers" mapstructure:"identifiers" flag:"identifiers" desc:"Identifiers List"`
}

ArkCmgrPoolIdentifiers is a struct representing a list of identifiers for pools in the Ark CMGR service.

type ArkCmgrPoolIdentifiersFilter 

type ArkCmgrPoolIdentifiersFilter struct {
	ArkCmgrListPoolIdentifiers
	ArkCmgrPoolsCommonFilter
}

ArkCmgrPoolIdentifiersFilter is a struct representing the filter for pool identifiers in the Ark CMGR service.

type ArkCmgrPoolsCommonFilter 

type ArkCmgrPoolsCommonFilter struct {
	Projection string `` /* 145-byte string literal not displayed */
	Sort       string `json:"sort,omitempty" mapstructure:"sort,omitempty" flag:"sort" desc:"Sort by given parameter"`
	Filter     string `json:"filter,omitempty" mapstructure:"filter,omitempty" flag:"filter" desc:"Filter parameters"`
	Order      string `` /* 126-byte string literal not displayed */
	PageSize   int    `json:"page_size,omitempty" mapstructure:"page_size,omitempty" flag:"page-size" desc:"Size of page"`
}

ArkCmgrPoolsCommonFilter is a struct representing the common filter for pools in the Ark CMGR service.

type ArkCmgrPoolsFilter 

type ArkCmgrPoolsFilter struct {
	ArkCmgrPoolsCommonFilter
}

ArkCmgrPoolsFilter is a struct representing the filter for pools in the Ark CMGR service.

type ArkCmgrPoolsStats 

type ArkCmgrPoolsStats struct {
	PoolsCount              int                       `json:"pools_count" mapstructure:"pools_count" flag:"pools-count" desc:"Overall count of pools"`
	NetworksCountPerPool    map[string]int            `` /* 139-byte string literal not displayed */
	IdentifiersCountPerPool map[string]int            `` /* 151-byte string literal not displayed */
	ComponentsCountPerPool  map[string]map[string]int `` /* 147-byte string literal not displayed */
}

ArkCmgrPoolsStats is a struct representing the statistics of pools in the Ark CMGR service.

type ArkCmgrUpdateNetwork 

type ArkCmgrUpdateNetwork struct {
	NetworkID string `json:"network_id" mapstructure:"network_id" flag:"network-id" desc:"ID of the network to update"`
	Name      string `json:"name,omitempty" mapstructure:"name,omitempty" flag:"name" desc:"New name of the network to update"`
}

ArkCmgrUpdateNetwork is a struct representing the request to update a network in the Ark CMGR service.

type ArkCmgrUpdatePool 

type ArkCmgrUpdatePool struct {
	PoolID             string   `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to update"`
	Name               string   `json:"name,omitempty" mapstructure:"name,omitempty" flag:"name" desc:"Name of the pool to update"`
	Description        string   `json:"description,omitempty" mapstructure:"description,omitempty" flag:"description" desc:"Pool description to update"`
	AssignedNetworkIDs []string `` /* 158-byte string literal not displayed */
}

ArkCmgrUpdatePool is a struct representing the request to update a pool in the Ark CMGR service.

type ArkCmgrUpdatePoolIdentifier 

type ArkCmgrUpdatePoolIdentifier struct {
	Type         string `` /* 379-byte string literal not displayed */
	Value        string `json:"value" mapstructure:"value" flag:"value" desc:"Value of the identifier"`
	IdentifierID string `json:"identifier_id" mapstructure:"identifier_id" flag:"identifier-id" desc:"ID of the identifier to update from the pool"`
	PoolID       string `json:"pool_id" mapstructure:"pool_id" flag:"pool-id" desc:"ID of the pool to update the identifier to"`
}

ArkCmgrUpdatePoolIdentifier is a struct representing the filter for updating identifiers in a pool in the Ark CMGR service.

Source Files

View all Source files

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.