auditapi

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: 2

README

Go API client for auditapi

The Audit Logs API lets you read audit log entries and track API calls or activities in the Bare Metal Cloud Portal.

Knowledge base articles to help you can be found here

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.

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 auditapi "github.com/phoenixnap/go-sdk-bmc/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 auditapi.ContextServerIndex of type int.

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

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

ctx := context.WithValue(context.Background(), auditapi.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 auditapi.ContextOperationServerIndices and auditapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), auditapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), auditapi.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

Authentication schemes defined for the API:

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

Example

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

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

func (ApiEventsGetRequest) Execute 

func (r ApiEventsGetRequest) Execute() ([]Event, *http.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"`
	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 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 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"`
	AdditionalProperties map[string]interface{}
}

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

func (Event) ToMap 

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

func (*Event) UnmarshalJSON 

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

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, *http.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, *http.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 MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, 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 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 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 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 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 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"`
	AdditionalProperties map[string]interface{}
}

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

func (UserInfo) ToMap 

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

func (*UserInfo) UnmarshalJSON 

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

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.