auditapi

package module
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Nov 22, 2021 License: MPL-2.0 Imports: 22 Imported by: 0

README

Go API client for auditapi

The API that receives and shows actions that an account has taken in the system.

All URLs are relative to (https://api.phoenixnap.com/audit/v1/)

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: 1.0.0
  • Build date: 2021-11-22T06:41:23.926653Z[Etc/UTC]
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://phoenixnap.com/

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 "./auditapi"

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://api.phoenixnap.com/audit/v1

Class Method HTTP request Description
EventsApi EventsGet Get /events List event logs.

Documentation For Models

Documentation For Authorization

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

Example

auth := context.WithValue(context.Background(), sw.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, sw.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

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 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 {
	EventsApi EventsApi
	// contains filtered or unexported fields
}

APIClient manages communication with the Audit Log API 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 APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

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

type ApiAction 

type ApiAction struct {
	// The name of the event.
	Name *string `json:"name,omitempty"`
	// The UTC time the event initiated.
	Timestamp time.Time `json:"timestamp"`
	UserInfo  UserInfo  `json:"userInfo"`
	Response  Response  `json:"response"`
	Request   Request   `json:"request"`
}

ApiAction struct for ApiAction

func NewApiAction 

func NewApiAction(timestamp time.Time, userInfo UserInfo, response Response, request Request) *ApiAction

NewApiAction instantiates a new ApiAction 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 NewApiActionWithDefaults 

func NewApiActionWithDefaults() *ApiAction

NewApiActionWithDefaults instantiates a new ApiAction 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 (*ApiAction) GetName 

func (o *ApiAction) GetName() string

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

func (*ApiAction) GetNameOk 

func (o *ApiAction) 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 (*ApiAction) GetRequest 

func (o *ApiAction) GetRequest() Request

GetRequest returns the Request field value

func (*ApiAction) GetRequestOk 

func (o *ApiAction) GetRequestOk() (*Request, bool)

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

func (*ApiAction) GetResponse 

func (o *ApiAction) GetResponse() Response

GetResponse returns the Response field value

func (*ApiAction) GetResponseOk 

func (o *ApiAction) GetResponseOk() (*Response, bool)

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

func (*ApiAction) GetTimestamp 

func (o *ApiAction) GetTimestamp() time.Time

GetTimestamp returns the Timestamp field value

func (*ApiAction) GetTimestampOk 

func (o *ApiAction) GetTimestampOk() (*time.Time, bool)

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

func (*ApiAction) GetUserInfo 

func (o *ApiAction) GetUserInfo() UserInfo

GetUserInfo returns the UserInfo field value

func (*ApiAction) GetUserInfoOk 

func (o *ApiAction) GetUserInfoOk() (*UserInfo, bool)

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

func (*ApiAction) HasName 

func (o *ApiAction) HasName() bool

HasName returns a boolean if a field has been set.

func (ApiAction) MarshalJSON 

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

func (*ApiAction) SetName 

func (o *ApiAction) SetName(v string)

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

func (*ApiAction) SetRequest 

func (o *ApiAction) SetRequest(v Request)

SetRequest sets field value

func (*ApiAction) SetResponse 

func (o *ApiAction) SetResponse(v Response)

SetResponse sets field value

func (*ApiAction) SetTimestamp 

func (o *ApiAction) SetTimestamp(v time.Time)

SetTimestamp sets field value

func (*ApiAction) SetUserInfo 

func (o *ApiAction) SetUserInfo(v UserInfo)

SetUserInfo sets field value

type ApiActionAllOf 

type ApiActionAllOf struct {
	Response Response `json:"response"`
	Request  Request  `json:"request"`
}

ApiActionAllOf struct for ApiActionAllOf

func NewApiActionAllOf 

func NewApiActionAllOf(response Response, request Request) *ApiActionAllOf

NewApiActionAllOf instantiates a new ApiActionAllOf 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 NewApiActionAllOfWithDefaults 

func NewApiActionAllOfWithDefaults() *ApiActionAllOf

NewApiActionAllOfWithDefaults instantiates a new ApiActionAllOf 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 (*ApiActionAllOf) GetRequest 

func (o *ApiActionAllOf) GetRequest() Request

GetRequest returns the Request field value

func (*ApiActionAllOf) GetRequestOk 

func (o *ApiActionAllOf) GetRequestOk() (*Request, bool)

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

func (*ApiActionAllOf) GetResponse 

func (o *ApiActionAllOf) GetResponse() Response

GetResponse returns the Response field value

func (*ApiActionAllOf) GetResponseOk 

func (o *ApiActionAllOf) GetResponseOk() (*Response, bool)

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

func (ApiActionAllOf) MarshalJSON 

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

func (*ApiActionAllOf) SetRequest 

func (o *ApiActionAllOf) SetRequest(v Request)

SetRequest sets field value

func (*ApiActionAllOf) SetResponse 

func (o *ApiActionAllOf) SetResponse(v Response)

SetResponse sets field value

type ApiEventsGetRequest 

type ApiEventsGetRequest struct {
	ApiService EventsApi
	// contains filtered or unexported fields
}

func (ApiEventsGetRequest) Execute 

func (r ApiEventsGetRequest) Execute() ([]Event, *_nethttp.Response, error)

func (ApiEventsGetRequest) From 

func (r ApiEventsGetRequest) From(from time.Time) ApiEventsGetRequest

From the date and time (inclusive) to filter event log records by.

func (ApiEventsGetRequest) Limit 

func (r ApiEventsGetRequest) Limit(limit int32) ApiEventsGetRequest

Limit the number of records returned.

func (ApiEventsGetRequest) Order 

func (r ApiEventsGetRequest) Order(order string) ApiEventsGetRequest

Ordering of the event's time. SortBy can be introduced later on.

func (ApiEventsGetRequest) To 

func (r ApiEventsGetRequest) To(to time.Time) ApiEventsGetRequest

To the date and time (inclusive) to filter event log records by.

func (ApiEventsGetRequest) Uri 

func (r ApiEventsGetRequest) Uri(uri string) ApiEventsGetRequest

The request uri.

func (ApiEventsGetRequest) Username 

func (r ApiEventsGetRequest) Username(username string) ApiEventsGetRequest

The username that did the actions.

func (ApiEventsGetRequest) Verb 

func (r ApiEventsGetRequest) Verb(verb string) ApiEventsGetRequest

The HTTP verb corresponding to the action.

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 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 Event 

type Event struct {
	// The name of the event.
	Name *string `json:"name,omitempty"`
	// The UTC time the event initiated.
	Timestamp time.Time `json:"timestamp"`
	UserInfo  UserInfo  `json:"userInfo"`
}

Event The event log.

func NewEvent 

func NewEvent(timestamp time.Time, userInfo UserInfo) *Event

NewEvent instantiates a new Event 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 NewEventWithDefaults 

func NewEventWithDefaults() *Event

NewEventWithDefaults instantiates a new Event 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 (*Event) GetName 

func (o *Event) GetName() string

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

func (*Event) GetNameOk 

func (o *Event) 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 (*Event) GetTimestamp 

func (o *Event) GetTimestamp() time.Time

GetTimestamp returns the Timestamp field value

func (*Event) GetTimestampOk 

func (o *Event) GetTimestampOk() (*time.Time, bool)

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

func (*Event) GetUserInfo 

func (o *Event) GetUserInfo() UserInfo

GetUserInfo returns the UserInfo field value

func (*Event) GetUserInfoOk 

func (o *Event) GetUserInfoOk() (*UserInfo, bool)

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

func (*Event) HasName 

func (o *Event) HasName() bool

HasName returns a boolean if a field has been set.

func (Event) MarshalJSON 

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

func (*Event) SetName 

func (o *Event) SetName(v string)

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

func (*Event) SetTimestamp 

func (o *Event) SetTimestamp(v time.Time)

SetTimestamp sets field value

func (*Event) SetUserInfo 

func (o *Event) SetUserInfo(v UserInfo)

SetUserInfo sets field value

type EventsApi 

type EventsApi interface {

	/*
		EventsGet List event logs.

		Retrieves the event logs for given time period. All date & times are in UTC.

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

	// EventsGetExecute executes the request
	//  @return []Event
	EventsGetExecute(r ApiEventsGetRequest) ([]Event, *_nethttp.Response, error)
}

type EventsApiService 

type EventsApiService service

EventsApiService EventsApi service

func (*EventsApiService) EventsGet 

func (a *EventsApiService) EventsGet(ctx _context.Context) ApiEventsGetRequest

EventsGet List event logs.

Retrieves the event logs for given time period. All date & times are in UTC. 

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

func (*EventsApiService) EventsGetExecute 

func (a *EventsApiService) EventsGetExecute(r ApiEventsGetRequest) ([]Event, *_nethttp.Response, error)

Execute executes the request 

@return []Event

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 Headers 

type Headers struct {
	// The UA String
	UserAgent string `json:"userAgent"`
}

Headers Headers request to be sent in the event log.

func NewHeaders 

func NewHeaders(userAgent string) *Headers

NewHeaders instantiates a new Headers 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 NewHeadersWithDefaults 

func NewHeadersWithDefaults() *Headers

NewHeadersWithDefaults instantiates a new Headers 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 (*Headers) GetUserAgent 

func (o *Headers) GetUserAgent() string

GetUserAgent returns the UserAgent field value

func (*Headers) GetUserAgentOk 

func (o *Headers) GetUserAgentOk() (*string, bool)

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

func (Headers) MarshalJSON 

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

func (*Headers) SetUserAgent 

func (o *Headers) SetUserAgent(v string)

SetUserAgent sets field value

type NullableApiAction 

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

func NewNullableApiAction 

func NewNullableApiAction(val *ApiAction) *NullableApiAction

func (NullableApiAction) Get 

func (v NullableApiAction) Get() *ApiAction

func (NullableApiAction) IsSet 

func (v NullableApiAction) IsSet() bool

func (NullableApiAction) MarshalJSON 

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

func (*NullableApiAction) Set 

func (v *NullableApiAction) Set(val *ApiAction)

func (*NullableApiAction) UnmarshalJSON 

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

func (*NullableApiAction) Unset 

func (v *NullableApiAction) Unset()

type NullableApiActionAllOf 

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

func NewNullableApiActionAllOf 

func NewNullableApiActionAllOf(val *ApiActionAllOf) *NullableApiActionAllOf

func (NullableApiActionAllOf) Get 

func (v NullableApiActionAllOf) Get() *ApiActionAllOf

func (NullableApiActionAllOf) IsSet 

func (v NullableApiActionAllOf) IsSet() bool

func (NullableApiActionAllOf) MarshalJSON 

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

func (*NullableApiActionAllOf) Set 

func (v *NullableApiActionAllOf) Set(val *ApiActionAllOf)

func (*NullableApiActionAllOf) UnmarshalJSON 

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

func (*NullableApiActionAllOf) Unset 

func (v *NullableApiActionAllOf) 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 NullableEvent 

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

func NewNullableEvent 

func NewNullableEvent(val *Event) *NullableEvent

func (NullableEvent) Get 

func (v NullableEvent) Get() *Event

func (NullableEvent) IsSet 

func (v NullableEvent) IsSet() bool

func (NullableEvent) MarshalJSON 

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

func (*NullableEvent) Set 

func (v *NullableEvent) Set(val *Event)

func (*NullableEvent) UnmarshalJSON 

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

func (*NullableEvent) Unset 

func (v *NullableEvent) 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 NullableHeaders 

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

func NewNullableHeaders 

func NewNullableHeaders(val *Headers) *NullableHeaders

func (NullableHeaders) Get 

func (v NullableHeaders) Get() *Headers

func (NullableHeaders) IsSet 

func (v NullableHeaders) IsSet() bool

func (NullableHeaders) MarshalJSON 

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

func (*NullableHeaders) Set 

func (v *NullableHeaders) Set(val *Headers)

func (*NullableHeaders) UnmarshalJSON 

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

func (*NullableHeaders) Unset 

func (v *NullableHeaders) 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 NullableRequest 

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

func NewNullableRequest 

func NewNullableRequest(val *Request) *NullableRequest

func (NullableRequest) Get 

func (v NullableRequest) Get() *Request

func (NullableRequest) IsSet 

func (v NullableRequest) IsSet() bool

func (NullableRequest) MarshalJSON 

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

func (*NullableRequest) Set 

func (v *NullableRequest) Set(val *Request)

func (*NullableRequest) UnmarshalJSON 

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

func (*NullableRequest) Unset 

func (v *NullableRequest) Unset()

type NullableResponse 

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

func NewNullableResponse 

func NewNullableResponse(val *Response) *NullableResponse

func (NullableResponse) Get 

func (v NullableResponse) Get() *Response

func (NullableResponse) IsSet 

func (v NullableResponse) IsSet() bool

func (NullableResponse) MarshalJSON 

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

func (*NullableResponse) Set 

func (v *NullableResponse) Set(val *Response)

func (*NullableResponse) UnmarshalJSON 

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

func (*NullableResponse) Unset 

func (v *NullableResponse) 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 NullableUserInfo 

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

func NewNullableUserInfo 

func NewNullableUserInfo(val *UserInfo) *NullableUserInfo

func (NullableUserInfo) Get 

func (v NullableUserInfo) Get() *UserInfo

func (NullableUserInfo) IsSet 

func (v NullableUserInfo) IsSet() bool

func (NullableUserInfo) MarshalJSON 

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

func (*NullableUserInfo) Set 

func (v *NullableUserInfo) Set(val *UserInfo)

func (*NullableUserInfo) UnmarshalJSON 

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

func (*NullableUserInfo) Unset 

func (v *NullableUserInfo) Unset()

type Request 

type Request struct {
	Headers Headers `json:"headers"`
	// The request URI.
	Uri string `json:"uri"`
	// The HTTP request verb.
	Verb string `json:"verb"`
}

Request The request details sent by the user.

func NewRequest 

func NewRequest(headers Headers, uri string, verb string) *Request

NewRequest instantiates a new Request 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 NewRequestWithDefaults 

func NewRequestWithDefaults() *Request

NewRequestWithDefaults instantiates a new Request 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 (*Request) GetHeaders 

func (o *Request) GetHeaders() Headers

GetHeaders returns the Headers field value

func (*Request) GetHeadersOk 

func (o *Request) GetHeadersOk() (*Headers, bool)

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

func (*Request) GetUri 

func (o *Request) GetUri() string

GetUri returns the Uri field value

func (*Request) GetUriOk 

func (o *Request) GetUriOk() (*string, bool)

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

func (*Request) GetVerb 

func (o *Request) GetVerb() string

GetVerb returns the Verb field value

func (*Request) GetVerbOk 

func (o *Request) GetVerbOk() (*string, bool)

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

func (Request) MarshalJSON 

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

func (*Request) SetHeaders 

func (o *Request) SetHeaders(v Headers)

SetHeaders sets field value

func (*Request) SetUri 

func (o *Request) SetUri(v string)

SetUri sets field value

func (*Request) SetVerb 

func (o *Request) SetVerb(v string)

SetVerb sets field value

type Response 

type Response struct {
	// The status code returned in the response sent to the API.
	StatusCode int32 `json:"statusCode"`
	// The ID of the resource that was created.
	ResourceId *string `json:"resourceId,omitempty"`
}

Response The response received from the cluster.

func NewResponse 

func NewResponse(statusCode int32) *Response

NewResponse instantiates a new Response 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 NewResponseWithDefaults 

func NewResponseWithDefaults() *Response

NewResponseWithDefaults instantiates a new Response 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 (*Response) GetResourceId 

func (o *Response) GetResourceId() string

GetResourceId returns the ResourceId field value if set, zero value otherwise.

func (*Response) GetResourceIdOk 

func (o *Response) GetResourceIdOk() (*string, bool)

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

func (*Response) GetStatusCode 

func (o *Response) GetStatusCode() int32

GetStatusCode returns the StatusCode field value

func (*Response) GetStatusCodeOk 

func (o *Response) GetStatusCodeOk() (*int32, bool)

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

func (*Response) HasResourceId 

func (o *Response) HasResourceId() bool

HasResourceId returns a boolean if a field has been set.

func (Response) MarshalJSON 

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

func (*Response) SetResourceId 

func (o *Response) SetResourceId(v string)

SetResourceId gets a reference to the given string and assigns it to the ResourceId field.

func (*Response) SetStatusCode 

func (o *Response) SetStatusCode(v int32)

SetStatusCode sets field value

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 UserInfo 

type UserInfo struct {
	// The BMC account ID
	AccountId string `json:"accountId"`
	// The client ID of the application
	ClientId *string `json:"clientId,omitempty"`
	// The logged in user or owner of the client application
	Username string `json:"username"`
}

UserInfo Details related to the user / application performing this request

func NewUserInfo 

func NewUserInfo(accountId string, username string) *UserInfo

NewUserInfo instantiates a new UserInfo 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 NewUserInfoWithDefaults 

func NewUserInfoWithDefaults() *UserInfo

NewUserInfoWithDefaults instantiates a new UserInfo 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 (*UserInfo) GetAccountId 

func (o *UserInfo) GetAccountId() string

GetAccountId returns the AccountId field value

func (*UserInfo) GetAccountIdOk 

func (o *UserInfo) GetAccountIdOk() (*string, bool)

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

func (*UserInfo) GetClientId 

func (o *UserInfo) GetClientId() string

GetClientId returns the ClientId field value if set, zero value otherwise.

func (*UserInfo) GetClientIdOk 

func (o *UserInfo) GetClientIdOk() (*string, bool)

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

func (*UserInfo) GetUsername 

func (o *UserInfo) GetUsername() string

GetUsername returns the Username field value

func (*UserInfo) GetUsernameOk 

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

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

func (*UserInfo) HasClientId 

func (o *UserInfo) HasClientId() bool

HasClientId returns a boolean if a field has been set.

func (UserInfo) MarshalJSON 

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

func (*UserInfo) SetAccountId 

func (o *UserInfo) SetAccountId(v string)

SetAccountId sets field value

func (*UserInfo) SetClientId 

func (o *UserInfo) SetClientId(v string)

SetClientId gets a reference to the given string and assigns it to the ClientId field.

func (*UserInfo) SetUsername 

func (o *UserInfo) SetUsername(v string)

SetUsername sets field value

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.