deploymentapi

type CreateParams struct {
	*api.API

	// Request from which to create the deployment, by combining this with
	// the Overrides fields, certain fields can be overridden centrally through
	// that struct.
	//
	// Additionally, a Request can be generated with depresourceapi.NewPayload().
	// For more information on that struct, please refer to its godoc.
	Request *models.DeploymentCreateRequest

	// Optional request_id to be sent in the Create which acts as an idempotency
	// token.
	RequestID string

	// PayloadOverrides are used as a definition of values which want to
	// be overridden within the resources themselves.
	Overrides *PayloadOverrides
}

type DeleteParams struct {
	*api.API
	DeploymentID string
}

type GetParams struct {
	// Required API instance.
	*api.API

	// Required Deployment identifier.
	DeploymentID string

	// Optional parameters
	deputil.QueryParams

	// Optionally convert the legacy plans to the current deployment format.
	ConvertLegacyPlans bool

	// RefID, when specified, skips auto-discovering the deployment resource
	// RefID and instead uses the one that's passed.
	RefID string
}

type GetResourceParams struct {
	GetParams

	Kind string
}

type ListParams struct {
	*api.API
}

type PayloadOverrides struct {
	// If set, it will override the deployment name.
	Name string

	// If set, it will override the region when not present in the
	// DeploymentCreateRequest.
	// Note this behavior is different from the rest of overrides
	// since this field tends to be populated by the global region
	// field which is implicit (by config) rather than explicit by flag.
	Region string

	// If set, it'll override all versions to match this one.
	Version string

	// ElasticsearchRefID used for the applications.
	ElasticsearchRefID string

	// OverrideRefIDs when set, it'll override all the application's ref_id.
	OverrideRefIDs bool

	// Slice of built-in enabled plugins.
	ElasticcsearchBuiltinPlugins []string
}

type PopulateRefIDParams struct {
	*api.API

	DeploymentID string
	Kind         string

	// RefID string pointer where the value is persisted.
	RefID *string
}

type RestoreParams struct {
	*api.API
	DeploymentID string

	RestoreSnapshot bool
}

type ResyncAllParams struct {
	*api.API
}

type ResyncParams struct {
	*api.API
	ID string
}

type SearchParams struct {
	*api.API

	Request *models.SearchRequest
}

type ShutdownParams struct {
	*api.API
	DeploymentID string

	SkipSnapshot bool
}

type UpdateParams struct {
	*api.API

	DeploymentID string
	Request      *models.DeploymentUpdateRequest

	// Optional values
	SkipSnapshot      bool
	HidePrunedOrphans bool

	// PayloadOverrides are used as a definition of values which want to
	// be overridden within the resources themselves.
	Overrides PayloadOverrides
}