pkg/api/platformapi/instanceconfigapi/list.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.

package instanceconfigapi

import (
	"context"

	"github.com/elastic/cloud-sdk-go/pkg/api"
	"github.com/elastic/cloud-sdk-go/pkg/api/apierror"
	"github.com/elastic/cloud-sdk-go/pkg/client/platform_configuration_instances"
	"github.com/elastic/cloud-sdk-go/pkg/models"
	"github.com/elastic/cloud-sdk-go/pkg/multierror"
	"github.com/elastic/cloud-sdk-go/pkg/util/ec"
)

// ListParams is used to list all of the available instance configurations.
type ListParams struct {
	*api.API
	Region          string
	ShowDeleted     bool
	ShowMaxZones    bool
	IncludeVersions bool
}

// Validate ensures that the parameters are correct.
func (params ListParams) Validate() error {
	var merr = multierror.NewPrefixed("invalid instance config list params")
	if params.API == nil {
		merr = merr.Append(apierror.ErrMissingAPI)
	}

	if err := ec.RequireRegionSet(params.Region); err != nil {
		merr = merr.Append(err)
	}

	return merr.ErrorOrNil()
}

// List returns an array of all instance configurations
func List(params ListParams) ([]*models.InstanceConfiguration, error) {
	if err := params.Validate(); err != nil {
		return nil, err
	}

	requestParams := platform_configuration_instances.NewGetInstanceConfigurationsParams().
		WithContext(api.WithRegion(context.Background(), params.Region))

	if params.ShowDeleted {
		requestParams = requestParams.WithShowDeleted(ec.Bool(true))
	}
	if params.ShowMaxZones {
		requestParams = requestParams.WithShowMaxZones(ec.Bool(true))
	}
	if params.IncludeVersions {
		requestParams = requestParams.WithIncludeVersions(ec.Bool(true))
	}

	res, err := params.API.V1API.PlatformConfigurationInstances.GetInstanceConfigurations(
		requestParams,
		params.AuthWriter,
	)

	if err != nil {
		return nil, apierror.Wrap(err)
	}

	return res.Payload, nil
}