ranchersolutionapi

package module
v3.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2024 License: MPL-2.0 Imports: 21 Imported by: 3

README

Go API client for ranchersolutionapi

Simplify enterprise-grade Kubernetes cluster operations and management with Rancher on Bare Metal Cloud. Deploy Kubernetes clusters using a few API calls.

Knowledge base articles to help you can be found here

All URLs are relative to (https://api.phoenixnap.com/solutions/rancher/v1beta)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ranchersolutionapi "github.com/phoenixnap/go-sdk-bmc/ranchersolutionapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value ranchersolutionapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ranchersolutionapi.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value ranchersolutionapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ranchersolutionapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using ranchersolutionapi.ContextOperationServerIndices and ranchersolutionapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), ranchersolutionapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), ranchersolutionapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.phoenixnap.com/solutions/rancher/v1beta

Class Method HTTP request Description
ClustersAPI ClustersGet Get /clusters Cluster list.
ClustersAPI ClustersIdDelete Delete /clusters/{id} Delete a cluster.
ClustersAPI ClustersIdGet Get /clusters/{id} Retrieve a Cluster
ClustersAPI ClustersPost Post /clusters Create a Rancher Server Deployment.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • bmc: Grants full access to bmc-api.
  • bmc.read: Grants read only access to bmc-api.

Example

auth := context.WithValue(context.Background(), ranchersolutionapi.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, ranchersolutionapi.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

support@phoenixnap.com

Documentation

Index

Constants

View Source
const SdkVersion = "3.0.2"

Variables

View Source
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	ClustersAPI ClustersAPI
	// contains filtered or unexported fields
}

APIClient manages communication with the Rancher Solution API API v0.1 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiClustersGetRequest

type ApiClustersGetRequest struct {
	ApiService ClustersAPI
	// contains filtered or unexported fields
}

func (ApiClustersGetRequest) Execute

func (r ApiClustersGetRequest) Execute() ([]Cluster, *http.Response, error)

type ApiClustersIdDeleteRequest

type ApiClustersIdDeleteRequest struct {
	ApiService ClustersAPI
	// contains filtered or unexported fields
}

func (ApiClustersIdDeleteRequest) Execute

type ApiClustersIdGetRequest

type ApiClustersIdGetRequest struct {
	ApiService ClustersAPI
	// contains filtered or unexported fields
}

func (ApiClustersIdGetRequest) Execute

type ApiClustersPostRequest

type ApiClustersPostRequest struct {
	ApiService ClustersAPI
	// contains filtered or unexported fields
}

func (ApiClustersPostRequest) Cluster

func (ApiClustersPostRequest) Execute

func (r ApiClustersPostRequest) Execute() (*Cluster, *http.Response, error)

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Cluster

type Cluster struct {
	// (Read-only) The Cluster identifier.
	Id *string `json:"id,omitempty"`
	// Cluster name. This field is autogenerated if not provided.
	Name *string `json:"name,omitempty"`
	// Cluster description.
	Description *string `json:"description,omitempty"`
	// Deployment location. Cannot be changed once a cluster is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`.
	Location string `json:"location"`
	// (Read-only) The Rancher version that was installed on the cluster during the first creation process.
	InitialClusterVersion *string `json:"initialClusterVersion,omitempty"`
	// The node pools associated with the cluster.
	NodePools             []NodePool             `json:"nodePools,omitempty"`
	Configuration         *RancherClusterConfig  `json:"configuration,omitempty"`
	Metadata              *RancherServerMetadata `json:"metadata,omitempty"`
	WorkloadConfiguration *WorkloadClusterConfig `json:"workloadConfiguration,omitempty"`
	// (Read-Only) The cluster status
	StatusDescription    *string `json:"statusDescription,omitempty"`
	AdditionalProperties map[string]interface{}
}

Cluster Cluster details.

func NewCluster

func NewCluster(location string) *Cluster

NewCluster instantiates a new Cluster object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewClusterWithDefaults

func NewClusterWithDefaults() *Cluster

NewClusterWithDefaults instantiates a new Cluster object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Cluster) GetConfiguration

func (o *Cluster) GetConfiguration() RancherClusterConfig

GetConfiguration returns the Configuration field value if set, zero value otherwise.

func (*Cluster) GetConfigurationOk

func (o *Cluster) GetConfigurationOk() (*RancherClusterConfig, bool)

GetConfigurationOk returns a tuple with the Configuration field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) GetDescription

func (o *Cluster) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*Cluster) GetDescriptionOk

func (o *Cluster) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) GetId

func (o *Cluster) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*Cluster) GetIdOk

func (o *Cluster) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) GetInitialClusterVersion

func (o *Cluster) GetInitialClusterVersion() string

GetInitialClusterVersion returns the InitialClusterVersion field value if set, zero value otherwise.

func (*Cluster) GetInitialClusterVersionOk

func (o *Cluster) GetInitialClusterVersionOk() (*string, bool)

GetInitialClusterVersionOk returns a tuple with the InitialClusterVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) GetLocation

func (o *Cluster) GetLocation() string

GetLocation returns the Location field value

func (*Cluster) GetLocationOk

func (o *Cluster) GetLocationOk() (*string, bool)

GetLocationOk returns a tuple with the Location field value and a boolean to check if the value has been set.

func (*Cluster) GetMetadata

func (o *Cluster) GetMetadata() RancherServerMetadata

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*Cluster) GetMetadataOk

func (o *Cluster) GetMetadataOk() (*RancherServerMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) GetName

func (o *Cluster) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*Cluster) GetNameOk

func (o *Cluster) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) GetNodePools

func (o *Cluster) GetNodePools() []NodePool

GetNodePools returns the NodePools field value if set, zero value otherwise.

func (*Cluster) GetNodePoolsOk

func (o *Cluster) GetNodePoolsOk() ([]NodePool, bool)

GetNodePoolsOk returns a tuple with the NodePools field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) GetStatusDescription

func (o *Cluster) GetStatusDescription() string

GetStatusDescription returns the StatusDescription field value if set, zero value otherwise.

func (*Cluster) GetStatusDescriptionOk

func (o *Cluster) GetStatusDescriptionOk() (*string, bool)

GetStatusDescriptionOk returns a tuple with the StatusDescription field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) GetWorkloadConfiguration

func (o *Cluster) GetWorkloadConfiguration() WorkloadClusterConfig

GetWorkloadConfiguration returns the WorkloadConfiguration field value if set, zero value otherwise.

func (*Cluster) GetWorkloadConfigurationOk

func (o *Cluster) GetWorkloadConfigurationOk() (*WorkloadClusterConfig, bool)

GetWorkloadConfigurationOk returns a tuple with the WorkloadConfiguration field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Cluster) HasConfiguration

func (o *Cluster) HasConfiguration() bool

HasConfiguration returns a boolean if a field has been set.

func (*Cluster) HasDescription

func (o *Cluster) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Cluster) HasId

func (o *Cluster) HasId() bool

HasId returns a boolean if a field has been set.

func (*Cluster) HasInitialClusterVersion

func (o *Cluster) HasInitialClusterVersion() bool

HasInitialClusterVersion returns a boolean if a field has been set.

func (*Cluster) HasMetadata

func (o *Cluster) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*Cluster) HasName

func (o *Cluster) HasName() bool

HasName returns a boolean if a field has been set.

func (*Cluster) HasNodePools

func (o *Cluster) HasNodePools() bool

HasNodePools returns a boolean if a field has been set.

func (*Cluster) HasStatusDescription

func (o *Cluster) HasStatusDescription() bool

HasStatusDescription returns a boolean if a field has been set.

func (*Cluster) HasWorkloadConfiguration

func (o *Cluster) HasWorkloadConfiguration() bool

HasWorkloadConfiguration returns a boolean if a field has been set.

func (Cluster) MarshalJSON

func (o Cluster) MarshalJSON() ([]byte, error)

func (*Cluster) SetConfiguration

func (o *Cluster) SetConfiguration(v RancherClusterConfig)

SetConfiguration gets a reference to the given RancherClusterConfig and assigns it to the Configuration field.

func (*Cluster) SetDescription

func (o *Cluster) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*Cluster) SetId

func (o *Cluster) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*Cluster) SetInitialClusterVersion

func (o *Cluster) SetInitialClusterVersion(v string)

SetInitialClusterVersion gets a reference to the given string and assigns it to the InitialClusterVersion field.

func (*Cluster) SetLocation

func (o *Cluster) SetLocation(v string)

SetLocation sets field value

func (*Cluster) SetMetadata

func (o *Cluster) SetMetadata(v RancherServerMetadata)

SetMetadata gets a reference to the given RancherServerMetadata and assigns it to the Metadata field.

func (*Cluster) SetName

func (o *Cluster) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*Cluster) SetNodePools

func (o *Cluster) SetNodePools(v []NodePool)

SetNodePools gets a reference to the given []NodePool and assigns it to the NodePools field.

func (*Cluster) SetStatusDescription

func (o *Cluster) SetStatusDescription(v string)

SetStatusDescription gets a reference to the given string and assigns it to the StatusDescription field.

func (*Cluster) SetWorkloadConfiguration

func (o *Cluster) SetWorkloadConfiguration(v WorkloadClusterConfig)

SetWorkloadConfiguration gets a reference to the given WorkloadClusterConfig and assigns it to the WorkloadConfiguration field.

func (Cluster) ToMap

func (o Cluster) ToMap() (map[string]interface{}, error)

func (*Cluster) UnmarshalJSON

func (o *Cluster) UnmarshalJSON(data []byte) (err error)

type ClustersAPI

type ClustersAPI interface {

	/*
		ClustersGet Cluster list.

		Cluster list.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiClustersGetRequest
	*/
	ClustersGet(ctx context.Context) ApiClustersGetRequest

	// ClustersGetExecute executes the request
	//  @return []Cluster
	ClustersGetExecute(r ApiClustersGetRequest) ([]Cluster, *http.Response, error)

	/*
		ClustersIdDelete Delete a cluster.

		Delete a cluster.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param id The Cluster identifier.
		@return ApiClustersIdDeleteRequest
	*/
	ClustersIdDelete(ctx context.Context, id string) ApiClustersIdDeleteRequest

	// ClustersIdDeleteExecute executes the request
	//  @return DeleteResult
	ClustersIdDeleteExecute(r ApiClustersIdDeleteRequest) (*DeleteResult, *http.Response, error)

	/*
		ClustersIdGet Retrieve a Cluster

		Retrieve a Cluster

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param id The Cluster identifier.
		@return ApiClustersIdGetRequest
	*/
	ClustersIdGet(ctx context.Context, id string) ApiClustersIdGetRequest

	// ClustersIdGetExecute executes the request
	//  @return Cluster
	ClustersIdGetExecute(r ApiClustersIdGetRequest) (*Cluster, *http.Response, error)

	/*
			ClustersPost Create a Rancher Server Deployment.

			Create a Rancher Server Deployment as described in <a href='https://rancher.com/docs/rancher/v2.5/en/overview/architecture/#rancher-server-architecture' target='_blank'>Rancher Docs Architecture</a>. Rancher Server allows the creation, import and management of multiple Downstream User Kubernetes Clusters.
		<b>This is not a Downstream User Cluster</b>. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/bmc-rancher-workload-cluster#ftoc-heading-5' target='_blank'>here</a>.


			@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
			@return ApiClustersPostRequest
	*/
	ClustersPost(ctx context.Context) ApiClustersPostRequest

	// ClustersPostExecute executes the request
	//  @return Cluster
	ClustersPostExecute(r ApiClustersPostRequest) (*Cluster, *http.Response, error)
}

type ClustersAPIService

type ClustersAPIService service

ClustersAPIService ClustersAPI service

func (*ClustersAPIService) ClustersGet

ClustersGet Cluster list.

Cluster list.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiClustersGetRequest

func (*ClustersAPIService) ClustersGetExecute

func (a *ClustersAPIService) ClustersGetExecute(r ApiClustersGetRequest) ([]Cluster, *http.Response, error)

Execute executes the request

@return []Cluster

func (*ClustersAPIService) ClustersIdDelete

ClustersIdDelete Delete a cluster.

Delete a cluster.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The Cluster identifier.
@return ApiClustersIdDeleteRequest

func (*ClustersAPIService) ClustersIdDeleteExecute

func (a *ClustersAPIService) ClustersIdDeleteExecute(r ApiClustersIdDeleteRequest) (*DeleteResult, *http.Response, error)

Execute executes the request

@return DeleteResult

func (*ClustersAPIService) ClustersIdGet

ClustersIdGet Retrieve a Cluster

Retrieve a Cluster

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The Cluster identifier.
@return ApiClustersIdGetRequest

func (*ClustersAPIService) ClustersIdGetExecute

func (a *ClustersAPIService) ClustersIdGetExecute(r ApiClustersIdGetRequest) (*Cluster, *http.Response, error)

Execute executes the request

@return Cluster

func (*ClustersAPIService) ClustersPost

ClustersPost Create a Rancher Server Deployment.

Create a Rancher Server Deployment as described in <a href='https://rancher.com/docs/rancher/v2.5/en/overview/architecture/#rancher-server-architecture' target='_blank'>Rancher Docs Architecture</a>. Rancher Server allows the creation, import and management of multiple Downstream User Kubernetes Clusters. <b>This is not a Downstream User Cluster</b>. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/bmc-rancher-workload-cluster#ftoc-heading-5' target='_blank'>here</a>.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiClustersPostRequest

func (*ClustersAPIService) ClustersPostExecute

func (a *ClustersAPIService) ClustersPostExecute(r ApiClustersPostRequest) (*Cluster, *http.Response, error)

Execute executes the request

@return Cluster

type Configuration

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	XPoweredBy       string            `json:"xPoweredBy,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type DeleteResult

type DeleteResult struct {
	// Solution cluster has been deleted.
	Result string `json:"result"`
	// The unique identifier of the solution cluster.
	ClusterId            string `json:"clusterId"`
	AdditionalProperties map[string]interface{}
}

DeleteResult Result of a successful delete action.

func NewDeleteResult

func NewDeleteResult(result string, clusterId string) *DeleteResult

NewDeleteResult instantiates a new DeleteResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDeleteResultWithDefaults

func NewDeleteResultWithDefaults() *DeleteResult

NewDeleteResultWithDefaults instantiates a new DeleteResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DeleteResult) GetClusterId

func (o *DeleteResult) GetClusterId() string

GetClusterId returns the ClusterId field value

func (*DeleteResult) GetClusterIdOk

func (o *DeleteResult) GetClusterIdOk() (*string, bool)

GetClusterIdOk returns a tuple with the ClusterId field value and a boolean to check if the value has been set.

func (*DeleteResult) GetResult

func (o *DeleteResult) GetResult() string

GetResult returns the Result field value

func (*DeleteResult) GetResultOk

func (o *DeleteResult) GetResultOk() (*string, bool)

GetResultOk returns a tuple with the Result field value and a boolean to check if the value has been set.

func (DeleteResult) MarshalJSON

func (o DeleteResult) MarshalJSON() ([]byte, error)

func (*DeleteResult) SetClusterId

func (o *DeleteResult) SetClusterId(v string)

SetClusterId sets field value

func (*DeleteResult) SetResult

func (o *DeleteResult) SetResult(v string)

SetResult sets field value

func (DeleteResult) ToMap

func (o DeleteResult) ToMap() (map[string]interface{}, error)

func (*DeleteResult) UnmarshalJSON

func (o *DeleteResult) UnmarshalJSON(data []byte) (err error)

type Error

type Error struct {
	// The description detailing the cause of the error code.
	Message string `json:"message"`
	// Validation errors, if any.
	ValidationErrors     []string `json:"validationErrors,omitempty"`
	AdditionalProperties map[string]interface{}
}

Error struct for Error

func NewError

func NewError(message string) *Error

NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorWithDefaults

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Error) GetMessage

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk

func (o *Error) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*Error) GetValidationErrors

func (o *Error) GetValidationErrors() []string

GetValidationErrors returns the ValidationErrors field value if set, zero value otherwise.

func (*Error) GetValidationErrorsOk

func (o *Error) GetValidationErrorsOk() ([]string, bool)

GetValidationErrorsOk returns a tuple with the ValidationErrors field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) HasValidationErrors

func (o *Error) HasValidationErrors() bool

HasValidationErrors returns a boolean if a field has been set.

func (Error) MarshalJSON

func (o Error) MarshalJSON() ([]byte, error)

func (*Error) SetMessage

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (*Error) SetValidationErrors

func (o *Error) SetValidationErrors(v []string)

SetValidationErrors gets a reference to the given []string and assigns it to the ValidationErrors field.

func (Error) ToMap

func (o Error) ToMap() (map[string]interface{}, error)

func (*Error) UnmarshalJSON

func (o *Error) UnmarshalJSON(data []byte) (err error)

type GenericOpenAPIError

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type MappedNullable

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type Node

type Node struct {
	// The server identifier.
	ServerId             *string `json:"serverId,omitempty"`
	AdditionalProperties map[string]interface{}
}

Node Node details.

func NewNode

func NewNode() *Node

NewNode instantiates a new Node object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewNodeWithDefaults

func NewNodeWithDefaults() *Node

NewNodeWithDefaults instantiates a new Node object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Node) GetServerId

func (o *Node) GetServerId() string

GetServerId returns the ServerId field value if set, zero value otherwise.

func (*Node) GetServerIdOk

func (o *Node) GetServerIdOk() (*string, bool)

GetServerIdOk returns a tuple with the ServerId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Node) HasServerId

func (o *Node) HasServerId() bool

HasServerId returns a boolean if a field has been set.

func (Node) MarshalJSON

func (o Node) MarshalJSON() ([]byte, error)

func (*Node) SetServerId

func (o *Node) SetServerId(v string)

SetServerId gets a reference to the given string and assigns it to the ServerId field.

func (Node) ToMap

func (o Node) ToMap() (map[string]interface{}, error)

func (*Node) UnmarshalJSON added in v3.0.1

func (o *Node) UnmarshalJSON(data []byte) (err error)

type NodePool

type NodePool struct {
	// The name of the node pool.
	Name *string `json:"name,omitempty"`
	// Number of configured nodes, currently only node counts of 1 and 3 are possible.
	NodeCount *int32 `json:"nodeCount,omitempty"`
	// Node server type. Cannot be changed once a server is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`.
	ServerType *string    `json:"serverType,omitempty"`
	SshConfig  *SshConfig `json:"sshConfig,omitempty"`
	// (Read-only) The nodes associated with this node pool.
	Nodes                []Node `json:"nodes,omitempty"`
	AdditionalProperties map[string]interface{}
}

NodePool Node Pool Configuration. A node pool contains the name and configuration for a cluster's node pool. Node pools are set of nodes with a common configuration and specification.

func NewNodePool

func NewNodePool() *NodePool

NewNodePool instantiates a new NodePool object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewNodePoolWithDefaults

func NewNodePoolWithDefaults() *NodePool

NewNodePoolWithDefaults instantiates a new NodePool object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*NodePool) GetName

func (o *NodePool) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*NodePool) GetNameOk

func (o *NodePool) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*NodePool) GetNodeCount

func (o *NodePool) GetNodeCount() int32

GetNodeCount returns the NodeCount field value if set, zero value otherwise.

func (*NodePool) GetNodeCountOk

func (o *NodePool) GetNodeCountOk() (*int32, bool)

GetNodeCountOk returns a tuple with the NodeCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*NodePool) GetNodes

func (o *NodePool) GetNodes() []Node

GetNodes returns the Nodes field value if set, zero value otherwise.

func (*NodePool) GetNodesOk

func (o *NodePool) GetNodesOk() ([]Node, bool)

GetNodesOk returns a tuple with the Nodes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*NodePool) GetServerType

func (o *NodePool) GetServerType() string

GetServerType returns the ServerType field value if set, zero value otherwise.

func (*NodePool) GetServerTypeOk

func (o *NodePool) GetServerTypeOk() (*string, bool)

GetServerTypeOk returns a tuple with the ServerType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*NodePool) GetSshConfig

func (o *NodePool) GetSshConfig() SshConfig

GetSshConfig returns the SshConfig field value if set, zero value otherwise.

func (*NodePool) GetSshConfigOk

func (o *NodePool) GetSshConfigOk() (*SshConfig, bool)

GetSshConfigOk returns a tuple with the SshConfig field value if set, nil otherwise and a boolean to check if the value has been set.

func (*NodePool) HasName

func (o *NodePool) HasName() bool

HasName returns a boolean if a field has been set.

func (*NodePool) HasNodeCount

func (o *NodePool) HasNodeCount() bool

HasNodeCount returns a boolean if a field has been set.

func (*NodePool) HasNodes

func (o *NodePool) HasNodes() bool

HasNodes returns a boolean if a field has been set.

func (*NodePool) HasServerType

func (o *NodePool) HasServerType() bool

HasServerType returns a boolean if a field has been set.

func (*NodePool) HasSshConfig

func (o *NodePool) HasSshConfig() bool

HasSshConfig returns a boolean if a field has been set.

func (NodePool) MarshalJSON

func (o NodePool) MarshalJSON() ([]byte, error)

func (*NodePool) SetName

func (o *NodePool) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*NodePool) SetNodeCount

func (o *NodePool) SetNodeCount(v int32)

SetNodeCount gets a reference to the given int32 and assigns it to the NodeCount field.

func (*NodePool) SetNodes

func (o *NodePool) SetNodes(v []Node)

SetNodes gets a reference to the given []Node and assigns it to the Nodes field.

func (*NodePool) SetServerType

func (o *NodePool) SetServerType(v string)

SetServerType gets a reference to the given string and assigns it to the ServerType field.

func (*NodePool) SetSshConfig

func (o *NodePool) SetSshConfig(v SshConfig)

SetSshConfig gets a reference to the given SshConfig and assigns it to the SshConfig field.

func (NodePool) ToMap

func (o NodePool) ToMap() (map[string]interface{}, error)

func (*NodePool) UnmarshalJSON added in v3.0.1

func (o *NodePool) UnmarshalJSON(data []byte) (err error)

type NullableBool

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableCluster

type NullableCluster struct {
	// contains filtered or unexported fields
}

func NewNullableCluster

func NewNullableCluster(val *Cluster) *NullableCluster

func (NullableCluster) Get

func (v NullableCluster) Get() *Cluster

func (NullableCluster) IsSet

func (v NullableCluster) IsSet() bool

func (NullableCluster) MarshalJSON

func (v NullableCluster) MarshalJSON() ([]byte, error)

func (*NullableCluster) Set

func (v *NullableCluster) Set(val *Cluster)

func (*NullableCluster) UnmarshalJSON

func (v *NullableCluster) UnmarshalJSON(src []byte) error

func (*NullableCluster) Unset

func (v *NullableCluster) Unset()

type NullableDeleteResult

type NullableDeleteResult struct {
	// contains filtered or unexported fields
}

func NewNullableDeleteResult

func NewNullableDeleteResult(val *DeleteResult) *NullableDeleteResult

func (NullableDeleteResult) Get

func (NullableDeleteResult) IsSet

func (v NullableDeleteResult) IsSet() bool

func (NullableDeleteResult) MarshalJSON

func (v NullableDeleteResult) MarshalJSON() ([]byte, error)

func (*NullableDeleteResult) Set

func (v *NullableDeleteResult) Set(val *DeleteResult)

func (*NullableDeleteResult) UnmarshalJSON

func (v *NullableDeleteResult) UnmarshalJSON(src []byte) error

func (*NullableDeleteResult) Unset

func (v *NullableDeleteResult) Unset()

type NullableError

type NullableError struct {
	// contains filtered or unexported fields
}

func NewNullableError

func NewNullableError(val *Error) *NullableError

func (NullableError) Get

func (v NullableError) Get() *Error

func (NullableError) IsSet

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON

func (v NullableError) MarshalJSON() ([]byte, error)

func (*NullableError) Set

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON

func (v *NullableError) UnmarshalJSON(src []byte) error

func (*NullableError) Unset

func (v *NullableError) Unset()

type NullableFloat32

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableInt

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableNode

type NullableNode struct {
	// contains filtered or unexported fields
}

func NewNullableNode

func NewNullableNode(val *Node) *NullableNode

func (NullableNode) Get

func (v NullableNode) Get() *Node

func (NullableNode) IsSet

func (v NullableNode) IsSet() bool

func (NullableNode) MarshalJSON

func (v NullableNode) MarshalJSON() ([]byte, error)

func (*NullableNode) Set

func (v *NullableNode) Set(val *Node)

func (*NullableNode) UnmarshalJSON

func (v *NullableNode) UnmarshalJSON(src []byte) error

func (*NullableNode) Unset

func (v *NullableNode) Unset()

type NullableNodePool

type NullableNodePool struct {
	// contains filtered or unexported fields
}

func NewNullableNodePool

func NewNullableNodePool(val *NodePool) *NullableNodePool

func (NullableNodePool) Get

func (v NullableNodePool) Get() *NodePool

func (NullableNodePool) IsSet

func (v NullableNodePool) IsSet() bool

func (NullableNodePool) MarshalJSON

func (v NullableNodePool) MarshalJSON() ([]byte, error)

func (*NullableNodePool) Set

func (v *NullableNodePool) Set(val *NodePool)

func (*NullableNodePool) UnmarshalJSON

func (v *NullableNodePool) UnmarshalJSON(src []byte) error

func (*NullableNodePool) Unset

func (v *NullableNodePool) Unset()

type NullableRancherClusterCertificates

type NullableRancherClusterCertificates struct {
	// contains filtered or unexported fields
}

func (NullableRancherClusterCertificates) Get

func (NullableRancherClusterCertificates) IsSet

func (NullableRancherClusterCertificates) MarshalJSON

func (v NullableRancherClusterCertificates) MarshalJSON() ([]byte, error)

func (*NullableRancherClusterCertificates) Set

func (*NullableRancherClusterCertificates) UnmarshalJSON

func (v *NullableRancherClusterCertificates) UnmarshalJSON(src []byte) error

func (*NullableRancherClusterCertificates) Unset

type NullableRancherClusterConfig

type NullableRancherClusterConfig struct {
	// contains filtered or unexported fields
}

func NewNullableRancherClusterConfig

func NewNullableRancherClusterConfig(val *RancherClusterConfig) *NullableRancherClusterConfig

func (NullableRancherClusterConfig) Get

func (NullableRancherClusterConfig) IsSet

func (NullableRancherClusterConfig) MarshalJSON

func (v NullableRancherClusterConfig) MarshalJSON() ([]byte, error)

func (*NullableRancherClusterConfig) Set

func (*NullableRancherClusterConfig) UnmarshalJSON

func (v *NullableRancherClusterConfig) UnmarshalJSON(src []byte) error

func (*NullableRancherClusterConfig) Unset

func (v *NullableRancherClusterConfig) Unset()

type NullableRancherServerMetadata

type NullableRancherServerMetadata struct {
	// contains filtered or unexported fields
}

func (NullableRancherServerMetadata) Get

func (NullableRancherServerMetadata) IsSet

func (NullableRancherServerMetadata) MarshalJSON

func (v NullableRancherServerMetadata) MarshalJSON() ([]byte, error)

func (*NullableRancherServerMetadata) Set

func (*NullableRancherServerMetadata) UnmarshalJSON

func (v *NullableRancherServerMetadata) UnmarshalJSON(src []byte) error

func (*NullableRancherServerMetadata) Unset

func (v *NullableRancherServerMetadata) Unset()

type NullableSshConfig

type NullableSshConfig struct {
	// contains filtered or unexported fields
}

func NewNullableSshConfig

func NewNullableSshConfig(val *SshConfig) *NullableSshConfig

func (NullableSshConfig) Get

func (v NullableSshConfig) Get() *SshConfig

func (NullableSshConfig) IsSet

func (v NullableSshConfig) IsSet() bool

func (NullableSshConfig) MarshalJSON

func (v NullableSshConfig) MarshalJSON() ([]byte, error)

func (*NullableSshConfig) Set

func (v *NullableSshConfig) Set(val *SshConfig)

func (*NullableSshConfig) UnmarshalJSON

func (v *NullableSshConfig) UnmarshalJSON(src []byte) error

func (*NullableSshConfig) Unset

func (v *NullableSshConfig) Unset()

type NullableString

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type NullableWorkloadClusterConfig

type NullableWorkloadClusterConfig struct {
	// contains filtered or unexported fields
}

func (NullableWorkloadClusterConfig) Get

func (NullableWorkloadClusterConfig) IsSet

func (NullableWorkloadClusterConfig) MarshalJSON

func (v NullableWorkloadClusterConfig) MarshalJSON() ([]byte, error)

func (*NullableWorkloadClusterConfig) Set

func (*NullableWorkloadClusterConfig) UnmarshalJSON

func (v *NullableWorkloadClusterConfig) UnmarshalJSON(src []byte) error

func (*NullableWorkloadClusterConfig) Unset

func (v *NullableWorkloadClusterConfig) Unset()

type RancherClusterCertificates

type RancherClusterCertificates struct {
	// The SSL CA certificate to be used for rancher admin.
	CaCertificate *string `json:"caCertificate,omitempty"`
	// The SSL certificate to be used for rancher admin.
	Certificate *string `json:"certificate,omitempty"`
	// The SSL certificate key to be used for rancher admin.
	CertificateKey       *string `json:"certificateKey,omitempty"`
	AdditionalProperties map[string]interface{}
}

RancherClusterCertificates (Write-only) Define the custom SSL certificates to be used instead of defaults.

func NewRancherClusterCertificates

func NewRancherClusterCertificates() *RancherClusterCertificates

NewRancherClusterCertificates instantiates a new RancherClusterCertificates object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRancherClusterCertificatesWithDefaults

func NewRancherClusterCertificatesWithDefaults() *RancherClusterCertificates

NewRancherClusterCertificatesWithDefaults instantiates a new RancherClusterCertificates object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*RancherClusterCertificates) GetCaCertificate

func (o *RancherClusterCertificates) GetCaCertificate() string

GetCaCertificate returns the CaCertificate field value if set, zero value otherwise.

func (*RancherClusterCertificates) GetCaCertificateOk

func (o *RancherClusterCertificates) GetCaCertificateOk() (*string, bool)

GetCaCertificateOk returns a tuple with the CaCertificate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterCertificates) GetCertificate

func (o *RancherClusterCertificates) GetCertificate() string

GetCertificate returns the Certificate field value if set, zero value otherwise.

func (*RancherClusterCertificates) GetCertificateKey

func (o *RancherClusterCertificates) GetCertificateKey() string

GetCertificateKey returns the CertificateKey field value if set, zero value otherwise.

func (*RancherClusterCertificates) GetCertificateKeyOk

func (o *RancherClusterCertificates) GetCertificateKeyOk() (*string, bool)

GetCertificateKeyOk returns a tuple with the CertificateKey field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterCertificates) GetCertificateOk

func (o *RancherClusterCertificates) GetCertificateOk() (*string, bool)

GetCertificateOk returns a tuple with the Certificate field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterCertificates) HasCaCertificate

func (o *RancherClusterCertificates) HasCaCertificate() bool

HasCaCertificate returns a boolean if a field has been set.

func (*RancherClusterCertificates) HasCertificate

func (o *RancherClusterCertificates) HasCertificate() bool

HasCertificate returns a boolean if a field has been set.

func (*RancherClusterCertificates) HasCertificateKey

func (o *RancherClusterCertificates) HasCertificateKey() bool

HasCertificateKey returns a boolean if a field has been set.

func (RancherClusterCertificates) MarshalJSON

func (o RancherClusterCertificates) MarshalJSON() ([]byte, error)

func (*RancherClusterCertificates) SetCaCertificate

func (o *RancherClusterCertificates) SetCaCertificate(v string)

SetCaCertificate gets a reference to the given string and assigns it to the CaCertificate field.

func (*RancherClusterCertificates) SetCertificate

func (o *RancherClusterCertificates) SetCertificate(v string)

SetCertificate gets a reference to the given string and assigns it to the Certificate field.

func (*RancherClusterCertificates) SetCertificateKey

func (o *RancherClusterCertificates) SetCertificateKey(v string)

SetCertificateKey gets a reference to the given string and assigns it to the CertificateKey field.

func (RancherClusterCertificates) ToMap

func (o RancherClusterCertificates) ToMap() (map[string]interface{}, error)

func (*RancherClusterCertificates) UnmarshalJSON added in v3.0.1

func (o *RancherClusterCertificates) UnmarshalJSON(data []byte) (err error)

type RancherClusterConfig

type RancherClusterConfig struct {
	// Shared secret used to join a server or agent to a cluster.
	Token *string `json:"token,omitempty"`
	// This maps to ranchers `tls-san`. Add additional hostname or IP as a Subject Alternative Name in the TLS cert.
	TlsSan *string `json:"tlsSan,omitempty"`
	// This maps to ranchers `etcd-snapshot-schedule-cron`. Snapshot interval time in cron spec. eg. every 5 hours ‘0 *_/5 * * *’. Default: at 12 am/pm
	EtcdSnapshotScheduleCron *string `json:"etcdSnapshotScheduleCron,omitempty"`
	// This maps to ranchers `etcd-snapshot-retention`. Number of snapshots to retain.
	EtcdSnapshotRetention *int32 `json:"etcdSnapshotRetention,omitempty"`
	// This maps to ranchers `node-taint`. Registering kubelet with set of taints. By default, server nodes will be schedulable and thus your workloads can get launched on them. If you wish to have a dedicated control plane where no user workloads will run, you can use taints.
	NodeTaint *string `json:"nodeTaint,omitempty"`
	// This maps to ranchers `cluster-domain`. Cluster Domain.
	ClusterDomain        *string                     `json:"clusterDomain,omitempty"`
	Certificates         *RancherClusterCertificates `json:"certificates,omitempty"`
	AdditionalProperties map[string]interface{}
}

RancherClusterConfig (Write-only) Rancher configuration parameters.

func NewRancherClusterConfig

func NewRancherClusterConfig() *RancherClusterConfig

NewRancherClusterConfig instantiates a new RancherClusterConfig object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRancherClusterConfigWithDefaults

func NewRancherClusterConfigWithDefaults() *RancherClusterConfig

NewRancherClusterConfigWithDefaults instantiates a new RancherClusterConfig object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*RancherClusterConfig) GetCertificates

func (o *RancherClusterConfig) GetCertificates() RancherClusterCertificates

GetCertificates returns the Certificates field value if set, zero value otherwise.

func (*RancherClusterConfig) GetCertificatesOk

func (o *RancherClusterConfig) GetCertificatesOk() (*RancherClusterCertificates, bool)

GetCertificatesOk returns a tuple with the Certificates field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterConfig) GetClusterDomain

func (o *RancherClusterConfig) GetClusterDomain() string

GetClusterDomain returns the ClusterDomain field value if set, zero value otherwise.

func (*RancherClusterConfig) GetClusterDomainOk

func (o *RancherClusterConfig) GetClusterDomainOk() (*string, bool)

GetClusterDomainOk returns a tuple with the ClusterDomain field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterConfig) GetEtcdSnapshotRetention

func (o *RancherClusterConfig) GetEtcdSnapshotRetention() int32

GetEtcdSnapshotRetention returns the EtcdSnapshotRetention field value if set, zero value otherwise.

func (*RancherClusterConfig) GetEtcdSnapshotRetentionOk

func (o *RancherClusterConfig) GetEtcdSnapshotRetentionOk() (*int32, bool)

GetEtcdSnapshotRetentionOk returns a tuple with the EtcdSnapshotRetention field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterConfig) GetEtcdSnapshotScheduleCron

func (o *RancherClusterConfig) GetEtcdSnapshotScheduleCron() string

GetEtcdSnapshotScheduleCron returns the EtcdSnapshotScheduleCron field value if set, zero value otherwise.

func (*RancherClusterConfig) GetEtcdSnapshotScheduleCronOk

func (o *RancherClusterConfig) GetEtcdSnapshotScheduleCronOk() (*string, bool)

GetEtcdSnapshotScheduleCronOk returns a tuple with the EtcdSnapshotScheduleCron field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterConfig) GetNodeTaint

func (o *RancherClusterConfig) GetNodeTaint() string

GetNodeTaint returns the NodeTaint field value if set, zero value otherwise.

func (*RancherClusterConfig) GetNodeTaintOk

func (o *RancherClusterConfig) GetNodeTaintOk() (*string, bool)

GetNodeTaintOk returns a tuple with the NodeTaint field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterConfig) GetTlsSan

func (o *RancherClusterConfig) GetTlsSan() string

GetTlsSan returns the TlsSan field value if set, zero value otherwise.

func (*RancherClusterConfig) GetTlsSanOk

func (o *RancherClusterConfig) GetTlsSanOk() (*string, bool)

GetTlsSanOk returns a tuple with the TlsSan field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterConfig) GetToken

func (o *RancherClusterConfig) GetToken() string

GetToken returns the Token field value if set, zero value otherwise.

func (*RancherClusterConfig) GetTokenOk

func (o *RancherClusterConfig) GetTokenOk() (*string, bool)

GetTokenOk returns a tuple with the Token field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherClusterConfig) HasCertificates

func (o *RancherClusterConfig) HasCertificates() bool

HasCertificates returns a boolean if a field has been set.

func (*RancherClusterConfig) HasClusterDomain

func (o *RancherClusterConfig) HasClusterDomain() bool

HasClusterDomain returns a boolean if a field has been set.

func (*RancherClusterConfig) HasEtcdSnapshotRetention

func (o *RancherClusterConfig) HasEtcdSnapshotRetention() bool

HasEtcdSnapshotRetention returns a boolean if a field has been set.

func (*RancherClusterConfig) HasEtcdSnapshotScheduleCron

func (o *RancherClusterConfig) HasEtcdSnapshotScheduleCron() bool

HasEtcdSnapshotScheduleCron returns a boolean if a field has been set.

func (*RancherClusterConfig) HasNodeTaint

func (o *RancherClusterConfig) HasNodeTaint() bool

HasNodeTaint returns a boolean if a field has been set.

func (*RancherClusterConfig) HasTlsSan

func (o *RancherClusterConfig) HasTlsSan() bool

HasTlsSan returns a boolean if a field has been set.

func (*RancherClusterConfig) HasToken

func (o *RancherClusterConfig) HasToken() bool

HasToken returns a boolean if a field has been set.

func (RancherClusterConfig) MarshalJSON

func (o RancherClusterConfig) MarshalJSON() ([]byte, error)

func (*RancherClusterConfig) SetCertificates

func (o *RancherClusterConfig) SetCertificates(v RancherClusterCertificates)

SetCertificates gets a reference to the given RancherClusterCertificates and assigns it to the Certificates field.

func (*RancherClusterConfig) SetClusterDomain

func (o *RancherClusterConfig) SetClusterDomain(v string)

SetClusterDomain gets a reference to the given string and assigns it to the ClusterDomain field.

func (*RancherClusterConfig) SetEtcdSnapshotRetention

func (o *RancherClusterConfig) SetEtcdSnapshotRetention(v int32)

SetEtcdSnapshotRetention gets a reference to the given int32 and assigns it to the EtcdSnapshotRetention field.

func (*RancherClusterConfig) SetEtcdSnapshotScheduleCron

func (o *RancherClusterConfig) SetEtcdSnapshotScheduleCron(v string)

SetEtcdSnapshotScheduleCron gets a reference to the given string and assigns it to the EtcdSnapshotScheduleCron field.

func (*RancherClusterConfig) SetNodeTaint

func (o *RancherClusterConfig) SetNodeTaint(v string)

SetNodeTaint gets a reference to the given string and assigns it to the NodeTaint field.

func (*RancherClusterConfig) SetTlsSan

func (o *RancherClusterConfig) SetTlsSan(v string)

SetTlsSan gets a reference to the given string and assigns it to the TlsSan field.

func (*RancherClusterConfig) SetToken

func (o *RancherClusterConfig) SetToken(v string)

SetToken gets a reference to the given string and assigns it to the Token field.

func (RancherClusterConfig) ToMap

func (o RancherClusterConfig) ToMap() (map[string]interface{}, error)

func (*RancherClusterConfig) UnmarshalJSON added in v3.0.1

func (o *RancherClusterConfig) UnmarshalJSON(data []byte) (err error)

type RancherServerMetadata

type RancherServerMetadata struct {
	// The Rancher Server URL.
	Url *string `json:"url,omitempty"`
	// The username to use to login to the Rancher Server. This field is returned only as a response to the create cluster request. Make sure to take note or you will not be able to access the server.
	Username *string `json:"username,omitempty"`
	// This is the password to be used to login to the Rancher Server. This field is returned only as a response to the create cluster request. Make sure to take note or you will not be able to access the server.
	Password             *string `json:"password,omitempty"`
	AdditionalProperties map[string]interface{}
}

RancherServerMetadata (Read Only) Connection parameters to use to connect to the Rancher Server Administrative GUI.

func NewRancherServerMetadata

func NewRancherServerMetadata() *RancherServerMetadata

NewRancherServerMetadata instantiates a new RancherServerMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRancherServerMetadataWithDefaults

func NewRancherServerMetadataWithDefaults() *RancherServerMetadata

NewRancherServerMetadataWithDefaults instantiates a new RancherServerMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*RancherServerMetadata) GetPassword

func (o *RancherServerMetadata) GetPassword() string

GetPassword returns the Password field value if set, zero value otherwise.

func (*RancherServerMetadata) GetPasswordOk

func (o *RancherServerMetadata) GetPasswordOk() (*string, bool)

GetPasswordOk returns a tuple with the Password field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherServerMetadata) GetUrl

func (o *RancherServerMetadata) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*RancherServerMetadata) GetUrlOk

func (o *RancherServerMetadata) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherServerMetadata) GetUsername

func (o *RancherServerMetadata) GetUsername() string

GetUsername returns the Username field value if set, zero value otherwise.

func (*RancherServerMetadata) GetUsernameOk

func (o *RancherServerMetadata) GetUsernameOk() (*string, bool)

GetUsernameOk returns a tuple with the Username field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RancherServerMetadata) HasPassword

func (o *RancherServerMetadata) HasPassword() bool

HasPassword returns a boolean if a field has been set.

func (*RancherServerMetadata) HasUrl

func (o *RancherServerMetadata) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (*RancherServerMetadata) HasUsername

func (o *RancherServerMetadata) HasUsername() bool

HasUsername returns a boolean if a field has been set.

func (RancherServerMetadata) MarshalJSON

func (o RancherServerMetadata) MarshalJSON() ([]byte, error)

func (*RancherServerMetadata) SetPassword

func (o *RancherServerMetadata) SetPassword(v string)

SetPassword gets a reference to the given string and assigns it to the Password field.

func (*RancherServerMetadata) SetUrl

func (o *RancherServerMetadata) SetUrl(v string)

SetUrl gets a reference to the given string and assigns it to the Url field.

func (*RancherServerMetadata) SetUsername

func (o *RancherServerMetadata) SetUsername(v string)

SetUsername gets a reference to the given string and assigns it to the Username field.

func (RancherServerMetadata) ToMap

func (o RancherServerMetadata) ToMap() (map[string]interface{}, error)

func (*RancherServerMetadata) UnmarshalJSON added in v3.0.1

func (o *RancherServerMetadata) UnmarshalJSON(data []byte) (err error)

type ServerConfiguration

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SshConfig

type SshConfig struct {
	// Define whether public keys marked as default should be installed on this node. These are public keys that were already recorded on this system. Use <a href='https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/get' target='_blank'>GET /ssh-keys</a> to retrieve a list of possible values.
	InstallDefaultKeys *bool `json:"installDefaultKeys,omitempty"`
	// List of public SSH keys.
	Keys []string `json:"keys,omitempty"`
	// List of public SSH key identifiers. These are public keys that were already recorded on this system. Use <a href='https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/get' target='_blank'>GET /ssh-keys</a> to retrieve a list of possible values.
	KeyIds               []string `json:"keyIds,omitempty"`
	AdditionalProperties map[string]interface{}
}

SshConfig (Write-only) Configuration defining which public SSH keys are pre-installed as authorized on the server.

func NewSshConfig

func NewSshConfig() *SshConfig

NewSshConfig instantiates a new SshConfig object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSshConfigWithDefaults

func NewSshConfigWithDefaults() *SshConfig

NewSshConfigWithDefaults instantiates a new SshConfig object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SshConfig) GetInstallDefaultKeys

func (o *SshConfig) GetInstallDefaultKeys() bool

GetInstallDefaultKeys returns the InstallDefaultKeys field value if set, zero value otherwise.

func (*SshConfig) GetInstallDefaultKeysOk

func (o *SshConfig) GetInstallDefaultKeysOk() (*bool, bool)

GetInstallDefaultKeysOk returns a tuple with the InstallDefaultKeys field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SshConfig) GetKeyIds

func (o *SshConfig) GetKeyIds() []string

GetKeyIds returns the KeyIds field value if set, zero value otherwise.

func (*SshConfig) GetKeyIdsOk

func (o *SshConfig) GetKeyIdsOk() ([]string, bool)

GetKeyIdsOk returns a tuple with the KeyIds field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SshConfig) GetKeys

func (o *SshConfig) GetKeys() []string

GetKeys returns the Keys field value if set, zero value otherwise.

func (*SshConfig) GetKeysOk

func (o *SshConfig) GetKeysOk() ([]string, bool)

GetKeysOk returns a tuple with the Keys field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SshConfig) HasInstallDefaultKeys

func (o *SshConfig) HasInstallDefaultKeys() bool

HasInstallDefaultKeys returns a boolean if a field has been set.

func (*SshConfig) HasKeyIds

func (o *SshConfig) HasKeyIds() bool

HasKeyIds returns a boolean if a field has been set.

func (*SshConfig) HasKeys

func (o *SshConfig) HasKeys() bool

HasKeys returns a boolean if a field has been set.

func (SshConfig) MarshalJSON

func (o SshConfig) MarshalJSON() ([]byte, error)

func (*SshConfig) SetInstallDefaultKeys

func (o *SshConfig) SetInstallDefaultKeys(v bool)

SetInstallDefaultKeys gets a reference to the given bool and assigns it to the InstallDefaultKeys field.

func (*SshConfig) SetKeyIds

func (o *SshConfig) SetKeyIds(v []string)

SetKeyIds gets a reference to the given []string and assigns it to the KeyIds field.

func (*SshConfig) SetKeys

func (o *SshConfig) SetKeys(v []string)

SetKeys gets a reference to the given []string and assigns it to the Keys field.

func (SshConfig) ToMap

func (o SshConfig) ToMap() (map[string]interface{}, error)

func (*SshConfig) UnmarshalJSON added in v3.0.1

func (o *SshConfig) UnmarshalJSON(data []byte) (err error)

type WorkloadClusterConfig

type WorkloadClusterConfig struct {
	// The name of the workload cluster. This field is autogenerated if not provided.
	Name *string `json:"name,omitempty"`
	// Number of configured servers. Currently only server counts of 1 and 3 are possible.
	ServerCount *int32 `json:"serverCount,omitempty"`
	// Node server type. Cannot be changed once the cluster is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `d1.c1.small`, `d1.c2.small`, `d1.c3.small`, `d1.c4.small`, `d1.c1.medium`, `d1.c2.medium`, `d1.c3.medium`, `d1.c4.medium`, `d1.c1.large`, `d1.c2.large`, `d1.c3.large`, `d1.c4.large`, `d1.m1.medium`, `d1.m2.medium`, `d1.m3.medium`, `d1.m4.medium`, `d2.c3.medium`, `d2.c4.medium`, `d2.c5.medium`, `d2.c3.large`, `d2.c4.large`, `d2.c5.large`, `d2.m2.medium`, `d2.m2.large` or `d2.m2.xlarge`.
	ServerType string `json:"serverType"`
	// Workload cluster location. Cannot be changed once cluster is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`.
	Location             string `json:"location"`
	AdditionalProperties map[string]interface{}
}

WorkloadClusterConfig (Write-only) Workload cluster configuration parameters.

func NewWorkloadClusterConfig

func NewWorkloadClusterConfig(serverType string, location string) *WorkloadClusterConfig

NewWorkloadClusterConfig instantiates a new WorkloadClusterConfig object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewWorkloadClusterConfigWithDefaults

func NewWorkloadClusterConfigWithDefaults() *WorkloadClusterConfig

NewWorkloadClusterConfigWithDefaults instantiates a new WorkloadClusterConfig object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*WorkloadClusterConfig) GetLocation

func (o *WorkloadClusterConfig) GetLocation() string

GetLocation returns the Location field value

func (*WorkloadClusterConfig) GetLocationOk

func (o *WorkloadClusterConfig) GetLocationOk() (*string, bool)

GetLocationOk returns a tuple with the Location field value and a boolean to check if the value has been set.

func (*WorkloadClusterConfig) GetName

func (o *WorkloadClusterConfig) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*WorkloadClusterConfig) GetNameOk

func (o *WorkloadClusterConfig) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*WorkloadClusterConfig) GetServerCount

func (o *WorkloadClusterConfig) GetServerCount() int32

GetServerCount returns the ServerCount field value if set, zero value otherwise.

func (*WorkloadClusterConfig) GetServerCountOk

func (o *WorkloadClusterConfig) GetServerCountOk() (*int32, bool)

GetServerCountOk returns a tuple with the ServerCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*WorkloadClusterConfig) GetServerType

func (o *WorkloadClusterConfig) GetServerType() string

GetServerType returns the ServerType field value

func (*WorkloadClusterConfig) GetServerTypeOk

func (o *WorkloadClusterConfig) GetServerTypeOk() (*string, bool)

GetServerTypeOk returns a tuple with the ServerType field value and a boolean to check if the value has been set.

func (*WorkloadClusterConfig) HasName

func (o *WorkloadClusterConfig) HasName() bool

HasName returns a boolean if a field has been set.

func (*WorkloadClusterConfig) HasServerCount

func (o *WorkloadClusterConfig) HasServerCount() bool

HasServerCount returns a boolean if a field has been set.

func (WorkloadClusterConfig) MarshalJSON

func (o WorkloadClusterConfig) MarshalJSON() ([]byte, error)

func (*WorkloadClusterConfig) SetLocation

func (o *WorkloadClusterConfig) SetLocation(v string)

SetLocation sets field value

func (*WorkloadClusterConfig) SetName

func (o *WorkloadClusterConfig) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*WorkloadClusterConfig) SetServerCount

func (o *WorkloadClusterConfig) SetServerCount(v int32)

SetServerCount gets a reference to the given int32 and assigns it to the ServerCount field.

func (*WorkloadClusterConfig) SetServerType

func (o *WorkloadClusterConfig) SetServerType(v string)

SetServerType sets field value

func (WorkloadClusterConfig) ToMap

func (o WorkloadClusterConfig) ToMap() (map[string]interface{}, error)

func (*WorkloadClusterConfig) UnmarshalJSON

func (o *WorkloadClusterConfig) UnmarshalJSON(data []byte) (err error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL