powerapi

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Feb 4, 2021 License: BSD-3-Clause Imports: 22 Imported by: 0

README

Go API client for powerapi

Docuemtnation for the PowerAPI Client Go Package (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.

  • API version: 1.0
  • Package version: 0.1.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

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 sw "./powerapi"

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 sw.ContextServerIndex of type int.

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

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

ctx := context.WithValue(context.Background(), sw.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 identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://example.api.com:8269/power/v1

Class Method HTTP request Description
DefaultApi AggregationServiceActionsAggregationServiceResetPost Post /AggregationService/Actions/AggregationService.Reset Request aggregate system reset
DefaultApi ComputerSystemsGet Get /ComputerSystems Get computer systems
DefaultApi ComputerSystemsNameActionsComputerSystemResetPost Post /ComputerSystems/{name}/Actions/ComputerSystem.Reset Request system reset
DefaultApi ComputerSystemsNameGet Get /ComputerSystems/{name} Get a specific computer system state

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

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

lowell@lanl.gov

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// 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 GetAPIBase 

func GetAPIBase(client *APIClient, ctx context.Context) string

func NodeToURI 

func NodeToURI(client *APIClient, ctx context.Context, name string) string

NameToURI returns the URI for a Name based on its name returns an empty string on failure

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.

func URIToNode 

func URIToNode(client *APIClient, ctx context.Context, uri string) string

URIToNode returns the Name of a node based on its URI returns an empty string on failure

Types

type APIClient 

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

APIClient manages communication with the Power API v1.0 API v1.0 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 APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

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

type AggregationResetBody 

type AggregationResetBody struct {
	ResetType *ResetType `json:"ResetType,omitempty"`
	// A list of system URIs to apply the reset to
	TargetURIs           *[]string `json:"TargetURIs,omitempty"`
	AdditionalProperties map[string]interface{}
}

AggregationResetBody Aggregation reset request

func NewAggregationResetBody 

func NewAggregationResetBody() *AggregationResetBody

NewAggregationResetBody instantiates a new AggregationResetBody 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 NewAggregationResetBodyWithDefaults 

func NewAggregationResetBodyWithDefaults() *AggregationResetBody

NewAggregationResetBodyWithDefaults instantiates a new AggregationResetBody 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 (*AggregationResetBody) GetResetType 

func (o *AggregationResetBody) GetResetType() ResetType

GetResetType returns the ResetType field value if set, zero value otherwise.

func (*AggregationResetBody) GetResetTypeOk 

func (o *AggregationResetBody) GetResetTypeOk() (*ResetType, bool)

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

func (*AggregationResetBody) GetTargetURIs 

func (o *AggregationResetBody) GetTargetURIs() []string

GetTargetURIs returns the TargetURIs field value if set, zero value otherwise.

func (*AggregationResetBody) GetTargetURIsOk 

func (o *AggregationResetBody) GetTargetURIsOk() (*[]string, bool)

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

func (*AggregationResetBody) HasResetType 

func (o *AggregationResetBody) HasResetType() bool

HasResetType returns a boolean if a field has been set.

func (*AggregationResetBody) HasTargetURIs 

func (o *AggregationResetBody) HasTargetURIs() bool

HasTargetURIs returns a boolean if a field has been set.

func (AggregationResetBody) MarshalJSON 

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

func (*AggregationResetBody) SetResetType 

func (o *AggregationResetBody) SetResetType(v ResetType)

SetResetType gets a reference to the given ResetType and assigns it to the ResetType field.

func (*AggregationResetBody) SetTargetURIs 

func (o *AggregationResetBody) SetTargetURIs(v []string)

SetTargetURIs gets a reference to the given []string and assigns it to the TargetURIs field.

func (*AggregationResetBody) UnmarshalJSON 

func (o *AggregationResetBody) UnmarshalJSON(bytes []byte) (err error)

type ApiAggregationServiceActionsAggregationServiceResetPostRequest 

type ApiAggregationServiceActionsAggregationServiceResetPostRequest struct {
	ApiService DefaultApi
	// contains filtered or unexported fields
}

func (ApiAggregationServiceActionsAggregationServiceResetPostRequest) AggregationResetBody 

func (r ApiAggregationServiceActionsAggregationServiceResetPostRequest) AggregationResetBody(aggregationResetBody AggregationResetBody) ApiAggregationServiceActionsAggregationServiceResetPostRequest

func (ApiAggregationServiceActionsAggregationServiceResetPostRequest) Execute 

func (r ApiAggregationServiceActionsAggregationServiceResetPostRequest) Execute() (AggregationResetBody, *_nethttp.Response, error)

type ApiComputerSystemsGetRequest 

type ApiComputerSystemsGetRequest struct {
	ApiService DefaultApi
	// contains filtered or unexported fields
}

func (ApiComputerSystemsGetRequest) Execute 

func (r ApiComputerSystemsGetRequest) Execute() (ComputerSystemCollection, *_nethttp.Response, error)

type ApiComputerSystemsNameActionsComputerSystemResetPostRequest 

type ApiComputerSystemsNameActionsComputerSystemResetPostRequest struct {
	ApiService DefaultApi
	// contains filtered or unexported fields
}

func (ApiComputerSystemsNameActionsComputerSystemResetPostRequest) Execute 

func (r ApiComputerSystemsNameActionsComputerSystemResetPostRequest) Execute() (ResetRequestBody, *_nethttp.Response, error)

func (ApiComputerSystemsNameActionsComputerSystemResetPostRequest) ResetRequestBody 

func (r ApiComputerSystemsNameActionsComputerSystemResetPostRequest) ResetRequestBody(resetRequestBody ResetRequestBody) ApiComputerSystemsNameActionsComputerSystemResetPostRequest

type ApiComputerSystemsNameGetRequest 

type ApiComputerSystemsNameGetRequest struct {
	ApiService DefaultApi
	// contains filtered or unexported fields
}

func (ApiComputerSystemsNameGetRequest) Execute 

func (r ApiComputerSystemsNameGetRequest) Execute() (ComputerSystem, *_nethttp.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 ComputerSystem 

type ComputerSystem struct {
	// An id is a URI-reference for the object
	Id string `json:"id"`
	// The name is the unique name identifier for the ComputerSystem. This is used to reference the system in the API.
	Name                 string      `json:"name"`
	PowerState           *PowerState `json:"powerState,omitempty"`
	AdditionalProperties map[string]interface{}
}

ComputerSystem A single computer system with power state

func NewComputerSystem 

func NewComputerSystem(id string, name string) *ComputerSystem

NewComputerSystem instantiates a new ComputerSystem 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 NewComputerSystemWithDefaults 

func NewComputerSystemWithDefaults() *ComputerSystem

NewComputerSystemWithDefaults instantiates a new ComputerSystem 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 (*ComputerSystem) GetId 

func (o *ComputerSystem) GetId() string

GetId returns the Id field value

func (*ComputerSystem) GetIdOk 

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

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

func (*ComputerSystem) GetName 

func (o *ComputerSystem) GetName() string

GetName returns the Name field value

func (*ComputerSystem) GetNameOk 

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

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

func (*ComputerSystem) GetPowerState 

func (o *ComputerSystem) GetPowerState() PowerState

GetPowerState returns the PowerState field value if set, zero value otherwise.

func (*ComputerSystem) GetPowerStateOk 

func (o *ComputerSystem) GetPowerStateOk() (*PowerState, bool)

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

func (*ComputerSystem) HasPowerState 

func (o *ComputerSystem) HasPowerState() bool

HasPowerState returns a boolean if a field has been set.

func (ComputerSystem) MarshalJSON 

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

func (*ComputerSystem) SetId 

func (o *ComputerSystem) SetId(v string)

SetId sets field value

func (*ComputerSystem) SetName 

func (o *ComputerSystem) SetName(v string)

SetName sets field value

func (*ComputerSystem) SetPowerState 

func (o *ComputerSystem) SetPowerState(v PowerState)

SetPowerState gets a reference to the given PowerState and assigns it to the PowerState field.

func (*ComputerSystem) UnmarshalJSON 

func (o *ComputerSystem) UnmarshalJSON(bytes []byte) (err error)

type ComputerSystemCollection 

type ComputerSystemCollection struct {
	// An id is a URI-reference for the object
	Id *string `json:"id,omitempty"`
	// Human-readable name for the collection
	Name *string `json:"name,omitempty"`
	// Collection of ComputerSystem objects
	Systems              *[]ComputerSystem `json:"systems,omitempty"`
	AdditionalProperties map[string]interface{}
}

ComputerSystemCollection A collection of computer systems

func NewComputerSystemCollection 

func NewComputerSystemCollection() *ComputerSystemCollection

NewComputerSystemCollection instantiates a new ComputerSystemCollection 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 NewComputerSystemCollectionWithDefaults 

func NewComputerSystemCollectionWithDefaults() *ComputerSystemCollection

NewComputerSystemCollectionWithDefaults instantiates a new ComputerSystemCollection 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 (*ComputerSystemCollection) GetId 

func (o *ComputerSystemCollection) GetId() string

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

func (*ComputerSystemCollection) GetIdOk 

func (o *ComputerSystemCollection) 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 (*ComputerSystemCollection) GetName 

func (o *ComputerSystemCollection) GetName() string

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

func (*ComputerSystemCollection) GetNameOk 

func (o *ComputerSystemCollection) 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 (*ComputerSystemCollection) GetSystems 

func (o *ComputerSystemCollection) GetSystems() []ComputerSystem

GetSystems returns the Systems field value if set, zero value otherwise.

func (*ComputerSystemCollection) GetSystemsOk 

func (o *ComputerSystemCollection) GetSystemsOk() (*[]ComputerSystem, bool)

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

func (*ComputerSystemCollection) HasId 

func (o *ComputerSystemCollection) HasId() bool

HasId returns a boolean if a field has been set.

func (*ComputerSystemCollection) HasName 

func (o *ComputerSystemCollection) HasName() bool

HasName returns a boolean if a field has been set.

func (*ComputerSystemCollection) HasSystems 

func (o *ComputerSystemCollection) HasSystems() bool

HasSystems returns a boolean if a field has been set.

func (ComputerSystemCollection) MarshalJSON 

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

func (*ComputerSystemCollection) SetId 

func (o *ComputerSystemCollection) SetId(v string)

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

func (*ComputerSystemCollection) SetName 

func (o *ComputerSystemCollection) SetName(v string)

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

func (*ComputerSystemCollection) SetSystems 

func (o *ComputerSystemCollection) SetSystems(v []ComputerSystem)

SetSystems gets a reference to the given []ComputerSystem and assigns it to the Systems field.

func (*ComputerSystemCollection) UnmarshalJSON 

func (o *ComputerSystemCollection) UnmarshalJSON(bytes []byte) (err error)

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"`
	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 DefaultApi 

type DefaultApi interface {

	/*
	 * AggregationServiceActionsAggregationServiceResetPost Request aggregate system reset
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return ApiAggregationServiceActionsAggregationServiceResetPostRequest
	 */
	AggregationServiceActionsAggregationServiceResetPost(ctx _context.Context) ApiAggregationServiceActionsAggregationServiceResetPostRequest

	/*
	 * AggregationServiceActionsAggregationServiceResetPostExecute executes the request
	 * @return AggregationResetBody
	 */
	AggregationServiceActionsAggregationServiceResetPostExecute(r ApiAggregationServiceActionsAggregationServiceResetPostRequest) (AggregationResetBody, *_nethttp.Response, error)

	/*
	 * ComputerSystemsGet Get computer systems
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return ApiComputerSystemsGetRequest
	 */
	ComputerSystemsGet(ctx _context.Context) ApiComputerSystemsGetRequest

	/*
	 * ComputerSystemsGetExecute executes the request
	 * @return ComputerSystemCollection
	 */
	ComputerSystemsGetExecute(r ApiComputerSystemsGetRequest) (ComputerSystemCollection, *_nethttp.Response, error)

	/*
	 * ComputerSystemsNameActionsComputerSystemResetPost Request system reset
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param name Unique name of the computer system
	 * @return ApiComputerSystemsNameActionsComputerSystemResetPostRequest
	 */
	ComputerSystemsNameActionsComputerSystemResetPost(ctx _context.Context, name string) ApiComputerSystemsNameActionsComputerSystemResetPostRequest

	/*
	 * ComputerSystemsNameActionsComputerSystemResetPostExecute executes the request
	 * @return ResetRequestBody
	 */
	ComputerSystemsNameActionsComputerSystemResetPostExecute(r ApiComputerSystemsNameActionsComputerSystemResetPostRequest) (ResetRequestBody, *_nethttp.Response, error)

	/*
	 * ComputerSystemsNameGet Get a specific computer system state
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param name Unique name of the computer system
	 * @return ApiComputerSystemsNameGetRequest
	 */
	ComputerSystemsNameGet(ctx _context.Context, name string) ApiComputerSystemsNameGetRequest

	/*
	 * ComputerSystemsNameGetExecute executes the request
	 * @return ComputerSystem
	 */
	ComputerSystemsNameGetExecute(r ApiComputerSystemsNameGetRequest) (ComputerSystem, *_nethttp.Response, error)
}

type DefaultApiService 

type DefaultApiService service

DefaultApiService DefaultApi service

func (*DefaultApiService) AggregationServiceActionsAggregationServiceResetPost 

func (a *DefaultApiService) AggregationServiceActionsAggregationServiceResetPost(ctx _context.Context) ApiAggregationServiceActionsAggregationServiceResetPostRequest

* AggregationServiceActionsAggregationServiceResetPost Request aggregate system reset * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return ApiAggregationServiceActionsAggregationServiceResetPostRequest

func (*DefaultApiService) AggregationServiceActionsAggregationServiceResetPostExecute 

func (a *DefaultApiService) AggregationServiceActionsAggregationServiceResetPostExecute(r ApiAggregationServiceActionsAggregationServiceResetPostRequest) (AggregationResetBody, *_nethttp.Response, error)

* Execute executes the request * @return AggregationResetBody

func (*DefaultApiService) ComputerSystemsGet 

func (a *DefaultApiService) ComputerSystemsGet(ctx _context.Context) ApiComputerSystemsGetRequest

* ComputerSystemsGet Get computer systems * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return ApiComputerSystemsGetRequest

func (*DefaultApiService) ComputerSystemsGetExecute 

func (a *DefaultApiService) ComputerSystemsGetExecute(r ApiComputerSystemsGetRequest) (ComputerSystemCollection, *_nethttp.Response, error)

* Execute executes the request * @return ComputerSystemCollection

func (*DefaultApiService) ComputerSystemsNameActionsComputerSystemResetPost 

func (a *DefaultApiService) ComputerSystemsNameActionsComputerSystemResetPost(ctx _context.Context, name string) ApiComputerSystemsNameActionsComputerSystemResetPostRequest

* ComputerSystemsNameActionsComputerSystemResetPost Request system reset * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param name Unique name of the computer system * @return ApiComputerSystemsNameActionsComputerSystemResetPostRequest

func (*DefaultApiService) ComputerSystemsNameActionsComputerSystemResetPostExecute 

func (a *DefaultApiService) ComputerSystemsNameActionsComputerSystemResetPostExecute(r ApiComputerSystemsNameActionsComputerSystemResetPostRequest) (ResetRequestBody, *_nethttp.Response, error)

* Execute executes the request * @return ResetRequestBody

func (*DefaultApiService) ComputerSystemsNameGet 

func (a *DefaultApiService) ComputerSystemsNameGet(ctx _context.Context, name string) ApiComputerSystemsNameGetRequest

* ComputerSystemsNameGet Get a specific computer system state * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param name Unique name of the computer system * @return ApiComputerSystemsNameGetRequest

func (*DefaultApiService) ComputerSystemsNameGetExecute 

func (a *DefaultApiService) ComputerSystemsNameGetExecute(r ApiComputerSystemsNameGetRequest) (ComputerSystem, *_nethttp.Response, error)

* Execute executes the request * @return ComputerSystem

type Error 

type Error struct {
	Error                *ErrorError `json:"error,omitempty"`
	AdditionalProperties map[string]interface{}
}

Error struct for Error

func NewError 

func NewError() *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) GetError 

func (o *Error) GetError() ErrorError

GetError returns the Error field value if set, zero value otherwise.

func (*Error) GetErrorOk 

func (o *Error) GetErrorOk() (*ErrorError, bool)

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

func (*Error) HasError 

func (o *Error) HasError() bool

HasError returns a boolean if a field has been set.

func (Error) MarshalJSON 

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

func (*Error) SetError 

func (o *Error) SetError(v ErrorError)

SetError gets a reference to the given ErrorError and assigns it to the Error field.

func (*Error) UnmarshalJSON 

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

type ErrorError 

type ErrorError struct {
	// Response code
	Code string `json:"code"`
	// A human-readable error message string
	Message              string `json:"message"`
	AdditionalProperties map[string]interface{}
}

ErrorError Properties that describe the error

func NewErrorError 

func NewErrorError(code string, message string) *ErrorError

NewErrorError instantiates a new ErrorError 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 NewErrorErrorWithDefaults 

func NewErrorErrorWithDefaults() *ErrorError

NewErrorErrorWithDefaults instantiates a new ErrorError 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 (*ErrorError) GetCode 

func (o *ErrorError) GetCode() string

GetCode returns the Code field value

func (*ErrorError) GetCodeOk 

func (o *ErrorError) GetCodeOk() (*string, bool)

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

func (*ErrorError) GetMessage 

func (o *ErrorError) GetMessage() string

GetMessage returns the Message field value

func (*ErrorError) GetMessageOk 

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

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

func (ErrorError) MarshalJSON 

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

func (*ErrorError) SetCode 

func (o *ErrorError) SetCode(v string)

SetCode sets field value

func (*ErrorError) SetMessage 

func (o *ErrorError) SetMessage(v string)

SetMessage sets field value

func (*ErrorError) UnmarshalJSON 

func (o *ErrorError) UnmarshalJSON(bytes []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 NullableAggregationResetBody 

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

func NewNullableAggregationResetBody 

func NewNullableAggregationResetBody(val *AggregationResetBody) *NullableAggregationResetBody

func (NullableAggregationResetBody) Get 

func (v NullableAggregationResetBody) Get() *AggregationResetBody

func (NullableAggregationResetBody) IsSet 

func (v NullableAggregationResetBody) IsSet() bool

func (NullableAggregationResetBody) MarshalJSON 

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

func (*NullableAggregationResetBody) Set 

func (v *NullableAggregationResetBody) Set(val *AggregationResetBody)

func (*NullableAggregationResetBody) UnmarshalJSON 

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

func (*NullableAggregationResetBody) Unset 

func (v *NullableAggregationResetBody) Unset()

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 NullableComputerSystem 

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

func NewNullableComputerSystem 

func NewNullableComputerSystem(val *ComputerSystem) *NullableComputerSystem

func (NullableComputerSystem) Get 

func (v NullableComputerSystem) Get() *ComputerSystem

func (NullableComputerSystem) IsSet 

func (v NullableComputerSystem) IsSet() bool

func (NullableComputerSystem) MarshalJSON 

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

func (*NullableComputerSystem) Set 

func (v *NullableComputerSystem) Set(val *ComputerSystem)

func (*NullableComputerSystem) UnmarshalJSON 

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

func (*NullableComputerSystem) Unset 

func (v *NullableComputerSystem) Unset()

type NullableComputerSystemCollection 

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

func NewNullableComputerSystemCollection 

func NewNullableComputerSystemCollection(val *ComputerSystemCollection) *NullableComputerSystemCollection

func (NullableComputerSystemCollection) Get 

func (v NullableComputerSystemCollection) Get() *ComputerSystemCollection

func (NullableComputerSystemCollection) IsSet 

func (v NullableComputerSystemCollection) IsSet() bool

func (NullableComputerSystemCollection) MarshalJSON 

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

func (*NullableComputerSystemCollection) Set 

func (v *NullableComputerSystemCollection) Set(val *ComputerSystemCollection)

func (*NullableComputerSystemCollection) UnmarshalJSON 

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

func (*NullableComputerSystemCollection) Unset 

func (v *NullableComputerSystemCollection) 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 NullableErrorError 

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

func NewNullableErrorError 

func NewNullableErrorError(val *ErrorError) *NullableErrorError

func (NullableErrorError) Get 

func (v NullableErrorError) Get() *ErrorError

func (NullableErrorError) IsSet 

func (v NullableErrorError) IsSet() bool

func (NullableErrorError) MarshalJSON 

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

func (*NullableErrorError) Set 

func (v *NullableErrorError) Set(val *ErrorError)

func (*NullableErrorError) UnmarshalJSON 

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

func (*NullableErrorError) Unset 

func (v *NullableErrorError) 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 NullablePowerState 

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

func NewNullablePowerState 

func NewNullablePowerState(val *PowerState) *NullablePowerState

func (NullablePowerState) Get 

func (v NullablePowerState) Get() *PowerState

func (NullablePowerState) IsSet 

func (v NullablePowerState) IsSet() bool

func (NullablePowerState) MarshalJSON 

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

func (*NullablePowerState) Set 

func (v *NullablePowerState) Set(val *PowerState)

func (*NullablePowerState) UnmarshalJSON 

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

func (*NullablePowerState) Unset 

func (v *NullablePowerState) Unset()

type NullableResetRequestBody 

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

func NewNullableResetRequestBody 

func NewNullableResetRequestBody(val *ResetRequestBody) *NullableResetRequestBody

func (NullableResetRequestBody) Get 

func (v NullableResetRequestBody) Get() *ResetRequestBody

func (NullableResetRequestBody) IsSet 

func (v NullableResetRequestBody) IsSet() bool

func (NullableResetRequestBody) MarshalJSON 

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

func (*NullableResetRequestBody) Set 

func (v *NullableResetRequestBody) Set(val *ResetRequestBody)

func (*NullableResetRequestBody) UnmarshalJSON 

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

func (*NullableResetRequestBody) Unset 

func (v *NullableResetRequestBody) Unset()

type NullableResetType 

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

func NewNullableResetType 

func NewNullableResetType(val *ResetType) *NullableResetType

func (NullableResetType) Get 

func (v NullableResetType) Get() *ResetType

func (NullableResetType) IsSet 

func (v NullableResetType) IsSet() bool

func (NullableResetType) MarshalJSON 

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

func (*NullableResetType) Set 

func (v *NullableResetType) Set(val *ResetType)

func (*NullableResetType) UnmarshalJSON 

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

func (*NullableResetType) Unset 

func (v *NullableResetType) 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 PowerState 

type PowerState string

PowerState Power state for a component 

const (
	POWERSTATE_ON  PowerState = "On"
	POWERSTATE_OFF PowerState = "Off"
)

List of PowerState

func (PowerState) Ptr 

func (v PowerState) Ptr() *PowerState

Ptr returns reference to PowerState value

func (*PowerState) UnmarshalJSON 

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

type ResetRequestBody 

type ResetRequestBody struct {
	ResetType            ResetType `json:"ResetType"`
	AdditionalProperties map[string]interface{}
}

ResetRequestBody Reset request

func NewResetRequestBody 

func NewResetRequestBody(resetType ResetType) *ResetRequestBody

NewResetRequestBody instantiates a new ResetRequestBody 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 NewResetRequestBodyWithDefaults 

func NewResetRequestBodyWithDefaults() *ResetRequestBody

NewResetRequestBodyWithDefaults instantiates a new ResetRequestBody 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 (*ResetRequestBody) GetResetType 

func (o *ResetRequestBody) GetResetType() ResetType

GetResetType returns the ResetType field value

func (*ResetRequestBody) GetResetTypeOk 

func (o *ResetRequestBody) GetResetTypeOk() (*ResetType, bool)

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

func (ResetRequestBody) MarshalJSON 

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

func (*ResetRequestBody) SetResetType 

func (o *ResetRequestBody) SetResetType(v ResetType)

SetResetType sets field value

func (*ResetRequestBody) UnmarshalJSON 

func (o *ResetRequestBody) UnmarshalJSON(bytes []byte) (err error)

type ResetType 

type ResetType string

ResetType the model 'ResetType' 

const (
	RESETTYPE_ON                ResetType = "On"
	RESETTYPE_FORCE_OFF         ResetType = "ForceOff"
	RESETTYPE_GRACEFUL_SHUTDOWN ResetType = "GracefulShutdown"
	RESETTYPE_GRACEFUL_RESTART  ResetType = "GracefulRestart"
	RESETTYPE_FORCE_RESTART     ResetType = "ForceRestart"
	RESETTYPE_NMI               ResetType = "Nmi"
	RESETTYPE_FORCE_ON          ResetType = "ForceOn"
	RESETTYPE_PUSH_POWER_BUTTON ResetType = "PushPowerButton"
	RESETTYPE_POWER_CYCLE       ResetType = "PowerCycle"
)

List of ResetType

func (ResetType) Ptr 

func (v ResetType) Ptr() *ResetType

Ptr returns reference to ResetType value

func (*ResetType) UnmarshalJSON 

func (v *ResetType) UnmarshalJSON(src []byte) 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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.