# Functions
BuildElasticsearchTopology receives an ElasticsearchCluster topology from the deployment template definition and what the user has specified through a simplified version of the deployment topology, iterating over the template topology and triying to match the types that the user can specify: ["ml", "data", "master"], with their instance configuration ID.
CancelPlan cancels a deployment resource plan.
DeleteStateless deletes a stateless deployment resource like APM, Kibana and App Search.
GetDeploymentInfo obtains the Deployment's elasticsearch relevant info and packs it into GetDeploymentInfoResponse.
LatestStackVersion obtains the latest stack version from the API given an empty version from the parameters, if the passed version is not empty, then it will be returned.
NewApm creates a *models.ApmPayload from the parameters.
NewAppSearch creates a *models.AppSearchPayload from the parameters.
NewElasticsearch creates a *models.ElasticsearchPayload from the parameters.
NewElasticsearchTopology creates a []ElasticsearchTopologyElement from a slice of raw strings which are then unmarshaled into the desired slice type.
NewElasticsearchTopologyElement creates a new topology element given a zone count and node size.
NewEnterpriseSearch creates a *models.EnterpriseSearchPayload from the parameters.
NewKibana creates a *models.KibanaPayload from the parameters.
NewPayload creates the payload for a deployment // * Auto-discovers the latest Stack version if Version is not specified.
ParseElasticsearchInput handles all but the API parameters as optional, providing a nicer API when it's used.
ResetElasticsearchPassword resets an deployment's elasticsearch password and returns the Username and Password.
Restore upgrades a stateless deployment resource like APM, Kibana and App Search.
Shutdown stops all the running instances for the specified resource kind ref ID on a Deployment.
Start starts all instances belonging to a deployment resource kind.
StartAllOrSpecified starts all or defined instances belonging to a deployment resource.
StartInstances starts defined instances belonging to a deployment resource.
StartInstancesMaintenanceMode starts maintenance mode of defined instances belonging to a deployment resource.
StartMaintenanceMode starts maintenance mode of all instances belonging to a deployment resource kind.
StartMaintenanceModeAllOrSpecified starts all or defined instances belonging to a deployment resource.
Stop stops all instances belonging to a deployment resource kind.
StopAllOrSpecified stops all or defined instances belonging to a deployment resource.
StopInstances stops defined instances belonging to a deployment resource.
StopInstancesMaintenanceMode stops maintenance mode of defined instances belonging to a deployment resource.
StopMaintenanceMode stops maintenance mode of all instances belonging to a deployment resource kind.
StopMaintenanceModeAllOrSpecified stops all or defined instances belonging to a deployment resource.
UpgradeStateless upgrades a stateless deployment resource like APM, Kibana and App Search.
# Constants
DataNode identifies the node type which stores data.
DefaultApmRefID is used when the RefID is not specified.
DefaultAppSearchRefID is used when the RefID is not specified.
DefaultDataSize defines the default node size for data nodes when not specified.
DefaultDataZoneCount defines the default number of zones a deployment spans.
DefaultElasticsearchRefID is used when the RefID is not specified.
DefaultEnterpriseSearchRefID is used when the RefID is not specified.
DefaultKibanaRefID is used when the RefID is not specified.
DefaultTemplateID is used when there's no template ID specified in the request.
MasterNode identifies the node type which is master elegible.
MLNode identifies the node type performing the Machine Learning.
# Variables
DefaultTopology will be used when no topology is specified.
DefaultTopologyElement defines the element used in DefaultTopology.
# Structs
BuildElasticsearchTopologyParams is consumed by BuildElasticsearchTopology.
CancelPlanParams is consumed by CancelPlan.
DeleteStatelessParams is consumed by Delete.
ElasticsearchTopologyElement is a single cluster topology element, meaning a number of instances (controlled by ZoneCount) for a single NodeType.
GetDeploymentInfoParams is consumed by GetDeploymentInfo.
GetDeploymentInfoResponse is returned by GetDeploymentInfo.
InstanceParams holds the common instance fields for a resource.
LatestStackVersionParams is consumed by LatestStackVersion.
NewElasticsearchParams is consumed by NewElasticsearch.
NewPayloadParams is consumed by NewPayload().
NewStateless is consumed by NewKibana.
Params can be embedded in any structure which makes use of the deployment/resource API which always require the fields.
ParseElasticsearchInputParams is consumed by ParseElasticsearchInput.
ResetElasticsearchPasswordParams is consumed by ResetElasticsearchPassword.
RestoreParams is consumed by Restore.
ShutdownParams is consumed by Shutdown.
StartInstancesParams is consumed by StartInstances.
StartParams is consumed by start.
StopInstancesParams is consumed by StopInstances.
StopParams is consumed by Stop.