instance_configuration.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. 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.

// Code generated by go-swagger; DO NOT EDIT.

package models

// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command

import (
	"context"
	"encoding/json"

	"github.com/go-openapi/errors"
	"github.com/go-openapi/strfmt"
	"github.com/go-openapi/swag"
	"github.com/go-openapi/validate"
)

// InstanceConfiguration The configuration template for Elasticsearch instances, Kibana instances, and APM Servers.
//
// swagger:model InstanceConfiguration
type InstanceConfiguration struct {

	// Optional filter to match allocators against
	AllocatorFilter *QueryContainer `json:"allocator_filter,omitempty"`

	// The zones this instance configuration may exist in. Leaving out this parameter or specifying an empty list implies all zones are allowed. Normally not needed, but can be useful for exceptional infrastructure constraints.
	AllowedZones []string `json:"allowed_zones"`

	// If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.
	ConfigVersion int32 `json:"config_version,omitempty"`

	// Settings for the instance CPU multiplier
	CPUMultiplier float64 `json:"cpu_multiplier,omitempty"`

	// Date/time that this instance configuration was marked for deletion
	// Format: date-time
	DeletedOn *strfmt.DateTime `json:"deleted_on,omitempty"`

	// Optional description for the instance configuration
	Description string `json:"description,omitempty"`

	// Numerics representing possible instance sizes that the instance configuration supports.
	// Required: true
	DiscreteSizes *DiscreteSizes `json:"discrete_sizes"`

	// Unique identifier for the instance configuration
	ID string `json:"id,omitempty"`

	// The type of instance. For instance configurations where the type is specified in the 'id', the default value of 'instance_type' will be automatically inferred.
	// Enum: [elasticsearch kibana apm integrations_server appsearch enterprise_search]
	InstanceType string `json:"instance_type,omitempty"`

	// The maximum number of availability zones in which this instance configuration has allocators. This field will be missing unless explicitly requested with the show_max_zones parameter.
	// Read Only: true
	MaxZones int32 `json:"max_zones,omitempty"`

	// Optional arbitrary metadata to associate with this template.
	Metadata interface{} `json:"metadata,omitempty"`

	// Display name for the instance configuration.
	// Required: true
	Name *string `json:"name"`

	// Node types (master, data) for the instance. For instance configurations where the type (and tier) is specified in the 'id', the default value of 'node_types' will be automatically inferred.
	NodeTypes []string `json:"node_types,omitempty"`

	// Settings for the instance storage multiplier
	StorageMultiplier float64 `json:"storage_multiplier,omitempty"`

	// Indicates if a instance configuration is system owned (restricts the set of operations that can be performed on it)
	SystemOwned *bool `json:"system_owned,omitempty"`
}

// Validate validates this instance configuration
func (m *InstanceConfiguration) Validate(formats strfmt.Registry) error {
	var res []error

	if err := m.validateAllocatorFilter(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateDeletedOn(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateDiscreteSizes(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateInstanceType(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateName(formats); err != nil {
		res = append(res, err)
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}

func (m *InstanceConfiguration) validateAllocatorFilter(formats strfmt.Registry) error {
	if swag.IsZero(m.AllocatorFilter) { // not required
		return nil
	}

	if m.AllocatorFilter != nil {
		if err := m.AllocatorFilter.Validate(formats); err != nil {
			if ve, ok := err.(*errors.Validation); ok {
				return ve.ValidateName("allocator_filter")
			} else if ce, ok := err.(*errors.CompositeError); ok {
				return ce.ValidateName("allocator_filter")
			}
			return err
		}
	}

	return nil
}

func (m *InstanceConfiguration) validateDeletedOn(formats strfmt.Registry) error {
	if swag.IsZero(m.DeletedOn) { // not required
		return nil
	}

	if err := validate.FormatOf("deleted_on", "body", "date-time", m.DeletedOn.String(), formats); err != nil {
		return err
	}

	return nil
}

func (m *InstanceConfiguration) validateDiscreteSizes(formats strfmt.Registry) error {

	if err := validate.Required("discrete_sizes", "body", m.DiscreteSizes); err != nil {
		return err
	}

	if m.DiscreteSizes != nil {
		if err := m.DiscreteSizes.Validate(formats); err != nil {
			if ve, ok := err.(*errors.Validation); ok {
				return ve.ValidateName("discrete_sizes")
			} else if ce, ok := err.(*errors.CompositeError); ok {
				return ce.ValidateName("discrete_sizes")
			}
			return err
		}
	}

	return nil
}

var instanceConfigurationTypeInstanceTypePropEnum []interface{}

func init() {
	var res []string
	if err := json.Unmarshal([]byte(`["elasticsearch","kibana","apm","integrations_server","appsearch","enterprise_search"]`), &res); err != nil {
		panic(err)
	}
	for _, v := range res {
		instanceConfigurationTypeInstanceTypePropEnum = append(instanceConfigurationTypeInstanceTypePropEnum, v)
	}
}

const (

	// InstanceConfigurationInstanceTypeElasticsearch captures enum value "elasticsearch"
	InstanceConfigurationInstanceTypeElasticsearch string = "elasticsearch"

	// InstanceConfigurationInstanceTypeKibana captures enum value "kibana"
	InstanceConfigurationInstanceTypeKibana string = "kibana"

	// InstanceConfigurationInstanceTypeApm captures enum value "apm"
	InstanceConfigurationInstanceTypeApm string = "apm"

	// InstanceConfigurationInstanceTypeIntegrationsServer captures enum value "integrations_server"
	InstanceConfigurationInstanceTypeIntegrationsServer string = "integrations_server"

	// InstanceConfigurationInstanceTypeAppsearch captures enum value "appsearch"
	InstanceConfigurationInstanceTypeAppsearch string = "appsearch"

	// InstanceConfigurationInstanceTypeEnterpriseSearch captures enum value "enterprise_search"
	InstanceConfigurationInstanceTypeEnterpriseSearch string = "enterprise_search"
)

// prop value enum
func (m *InstanceConfiguration) validateInstanceTypeEnum(path, location string, value string) error {
	if err := validate.EnumCase(path, location, value, instanceConfigurationTypeInstanceTypePropEnum, true); err != nil {
		return err
	}
	return nil
}

func (m *InstanceConfiguration) validateInstanceType(formats strfmt.Registry) error {
	if swag.IsZero(m.InstanceType) { // not required
		return nil
	}

	// value enum
	if err := m.validateInstanceTypeEnum("instance_type", "body", m.InstanceType); err != nil {
		return err
	}

	return nil
}

func (m *InstanceConfiguration) validateName(formats strfmt.Registry) error {

	if err := validate.Required("name", "body", m.Name); err != nil {
		return err
	}

	return nil
}

// ContextValidate validate this instance configuration based on the context it is used
func (m *InstanceConfiguration) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
	var res []error

	if err := m.contextValidateAllocatorFilter(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateDiscreteSizes(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateMaxZones(ctx, formats); err != nil {
		res = append(res, err)
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}

func (m *InstanceConfiguration) contextValidateAllocatorFilter(ctx context.Context, formats strfmt.Registry) error {

	if m.AllocatorFilter != nil {
		if err := m.AllocatorFilter.ContextValidate(ctx, formats); err != nil {
			if ve, ok := err.(*errors.Validation); ok {
				return ve.ValidateName("allocator_filter")
			} else if ce, ok := err.(*errors.CompositeError); ok {
				return ce.ValidateName("allocator_filter")
			}
			return err
		}
	}

	return nil
}

func (m *InstanceConfiguration) contextValidateDiscreteSizes(ctx context.Context, formats strfmt.Registry) error {

	if m.DiscreteSizes != nil {
		if err := m.DiscreteSizes.ContextValidate(ctx, formats); err != nil {
			if ve, ok := err.(*errors.Validation); ok {
				return ve.ValidateName("discrete_sizes")
			} else if ce, ok := err.(*errors.CompositeError); ok {
				return ce.ValidateName("discrete_sizes")
			}
			return err
		}
	}

	return nil
}

func (m *InstanceConfiguration) contextValidateMaxZones(ctx context.Context, formats strfmt.Registry) error {

	if err := validate.ReadOnly(ctx, "max_zones", "body", int32(m.MaxZones)); err != nil {
		return err
	}

	return nil
}

// MarshalBinary interface implementation
func (m *InstanceConfiguration) MarshalBinary() ([]byte, error) {
	if m == nil {
		return nil, nil
	}
	return swag.WriteJSON(m)
}

// UnmarshalBinary interface implementation
func (m *InstanceConfiguration) UnmarshalBinary(b []byte) error {
	var res InstanceConfiguration
	if err := swag.ReadJSON(b, &res); err != nil {
		return err
	}
	*m = res
	return nil
}