edge-api/rest_management_api_client/settings/settings_client.go

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

//
// Copyright NetFoundry Inc.
//
// Licensed 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
//
// https://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.
//
// __          __              _
// \ \        / /             (_)
//  \ \  /\  / /_ _ _ __ _ __  _ _ __   __ _
//   \ \/  \/ / _` | '__| '_ \| | '_ \ / _` |
//    \  /\  / (_| | |  | | | | | | | | (_| | : This file is generated, do not edit it.
//     \/  \/ \__,_|_|  |_| |_|_|_| |_|\__, |
//                                      __/ |
//                                     |___/

package settings

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

import (
	"fmt"

	"github.com/go-openapi/runtime"
	httptransport "github.com/go-openapi/runtime/client"
	"github.com/go-openapi/strfmt"
)

// New creates a new settings API client.
func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService {
	return &Client{transport: transport, formats: formats}
}

// New creates a new settings API client with basic auth credentials.
// It takes the following parameters:
// - host: http host (github.com).
// - basePath: any base path for the API client ("/v1", "/v3").
// - scheme: http scheme ("http", "https").
// - user: user for basic authentication header.
// - password: password for basic authentication header.
func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService {
	transport := httptransport.New(host, basePath, []string{scheme})
	transport.DefaultAuthentication = httptransport.BasicAuth(user, password)
	return &Client{transport: transport, formats: strfmt.Default}
}

// New creates a new settings API client with a bearer token for authentication.
// It takes the following parameters:
// - host: http host (github.com).
// - basePath: any base path for the API client ("/v1", "/v3").
// - scheme: http scheme ("http", "https").
// - bearerToken: bearer token for Bearer authentication header.
func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService {
	transport := httptransport.New(host, basePath, []string{scheme})
	transport.DefaultAuthentication = httptransport.BearerToken(bearerToken)
	return &Client{transport: transport, formats: strfmt.Default}
}

/*
Client for settings API
*/
type Client struct {
	transport runtime.ClientTransport
	formats   strfmt.Registry
}

// ClientOption may be used to customize the behavior of Client methods.
type ClientOption func(*runtime.ClientOperation)

// ClientService is the interface for Client methods
type ClientService interface {
	CreateControllerSetting(params *CreateControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateControllerSettingCreated, error)

	DeleteControllerSetting(params *DeleteControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteControllerSettingOK, error)

	DetailControllerSetting(params *DetailControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DetailControllerSettingOK, error)

	DetailControllerSettingEffective(params *DetailControllerSettingEffectiveParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DetailControllerSettingEffectiveOK, error)

	ListControllerSettings(params *ListControllerSettingsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListControllerSettingsOK, error)

	PatchControllerSetting(params *PatchControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PatchControllerSettingOK, error)

	UpdateControllerSetting(params *UpdateControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateControllerSettingOK, error)

	SetTransport(transport runtime.ClientTransport)
}

/*
CreateControllerSetting creates a controller specific setting

Create a new controller specific settings object. Requires admin access.
*/
func (a *Client) CreateControllerSetting(params *CreateControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateControllerSettingCreated, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewCreateControllerSettingParams()
	}
	op := &runtime.ClientOperation{
		ID:                 "createControllerSetting",
		Method:             "POST",
		PathPattern:        "/controller-settings",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &CreateControllerSettingReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	}
	for _, opt := range opts {
		opt(op)
	}
	result, err := a.transport.Submit(op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*CreateControllerSettingCreated)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for createControllerSetting: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

/*
DeleteControllerSetting deletes a controller setting object

Delete a controller setting object by id. Requires admin access.
*/
func (a *Client) DeleteControllerSetting(params *DeleteControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteControllerSettingOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewDeleteControllerSettingParams()
	}
	op := &runtime.ClientOperation{
		ID:                 "deleteControllerSetting",
		Method:             "DELETE",
		PathPattern:        "/controller-settings/{id}/effective",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &DeleteControllerSettingReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	}
	for _, opt := range opts {
		opt(op)
	}
	result, err := a.transport.Submit(op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*DeleteControllerSettingOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for deleteControllerSetting: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

/*
DetailControllerSetting retrieves a single controller setting object

Retrieves a single controller setting object by id. Requires admin access.
*/
func (a *Client) DetailControllerSetting(params *DetailControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DetailControllerSettingOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewDetailControllerSettingParams()
	}
	op := &runtime.ClientOperation{
		ID:                 "detailControllerSetting",
		Method:             "GET",
		PathPattern:        "/controller-settings/{id}",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &DetailControllerSettingReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	}
	for _, opt := range opts {
		opt(op)
	}
	result, err := a.transport.Submit(op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*DetailControllerSettingOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for detailControllerSetting: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

/*
DetailControllerSettingEffective retrieves a single controller s effective calculated settings from the instance and global configuration

Retrieves a single controller's effective setting object by id. Requires admin access.
*/
func (a *Client) DetailControllerSettingEffective(params *DetailControllerSettingEffectiveParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DetailControllerSettingEffectiveOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewDetailControllerSettingEffectiveParams()
	}
	op := &runtime.ClientOperation{
		ID:                 "detailControllerSettingEffective",
		Method:             "GET",
		PathPattern:        "/controller-settings/{id}/effective",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &DetailControllerSettingEffectiveReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	}
	for _, opt := range opts {
		opt(op)
	}
	result, err := a.transport.Submit(op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*DetailControllerSettingEffectiveOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for detailControllerSettingEffective: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

/*
ListControllerSettings lists controller settings

Retrieves a list controller settings including the base `global` settings object and any overriding controller specific settings.
*/
func (a *Client) ListControllerSettings(params *ListControllerSettingsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListControllerSettingsOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewListControllerSettingsParams()
	}
	op := &runtime.ClientOperation{
		ID:                 "listControllerSettings",
		Method:             "GET",
		PathPattern:        "/controller-settings",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &ListControllerSettingsReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	}
	for _, opt := range opts {
		opt(op)
	}
	result, err := a.transport.Submit(op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*ListControllerSettingsOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for listControllerSettings: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

/*
PatchControllerSetting updates the supplied fields on a controller setting object

Update the supplied fields on a controller setting object. Requires admin access.
*/
func (a *Client) PatchControllerSetting(params *PatchControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PatchControllerSettingOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPatchControllerSettingParams()
	}
	op := &runtime.ClientOperation{
		ID:                 "patchControllerSetting",
		Method:             "PATCH",
		PathPattern:        "/controller-settings/{id}/effective",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &PatchControllerSettingReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	}
	for _, opt := range opts {
		opt(op)
	}
	result, err := a.transport.Submit(op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*PatchControllerSettingOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for patchControllerSetting: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

/*
UpdateControllerSetting updates all fields on a controller setting object

Update all fields on a controller setting object by id. Requires admin access.
*/
func (a *Client) UpdateControllerSetting(params *UpdateControllerSettingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateControllerSettingOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewUpdateControllerSettingParams()
	}
	op := &runtime.ClientOperation{
		ID:                 "updateControllerSetting",
		Method:             "PUT",
		PathPattern:        "/controller-settings/{id}/effective",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &UpdateControllerSettingReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	}
	for _, opt := range opts {
		opt(op)
	}
	result, err := a.transport.Submit(op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*UpdateControllerSettingOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for updateControllerSetting: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// SetTransport changes the transport on the client
func (a *Client) SetTransport(transport runtime.ClientTransport) {
	a.transport = transport
}