variables

package
v0.127.0 Latest Latest
Warning

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

 Go to latest Published: Apr 11, 2024 License: MIT Imports: 20 Imported by: 1

README

Go API client for variables

No description provided (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.0
  • Package version: 1.0.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/net/context

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

import variables "github.com/GIT_USER_ID/GIT_REPO_ID"

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(), variables.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(), variables.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 sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://api.azionapi.net

Class Method HTTP request Description
VariablesAPI ApiVariablesCreate Post /variables /variables
VariablesAPI ApiVariablesDestroy Delete /variables/{uuid} /variables/:uuid
VariablesAPI ApiVariablesList Get /variables /variables
VariablesAPI ApiVariablesRetrieve Get /variables/{uuid} /variables/:uuid
VariablesAPI ApiVariablesUpdate Put /variables/{uuid} /variables/:uuid

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth
  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
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

Documentation

Index

Constants

This section is empty.

Variables

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

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

APIClient manages communication with the Variables API API v1.0.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 ApiApiVariablesCreateRequest 

type ApiApiVariablesCreateRequest struct {
	ApiService *VariablesAPIService
	// contains filtered or unexported fields
}

func (ApiApiVariablesCreateRequest) Execute 

func (r ApiApiVariablesCreateRequest) Execute() (*VariableGet, *http.Response, error)

func (ApiApiVariablesCreateRequest) VariableCreate 

func (r ApiApiVariablesCreateRequest) VariableCreate(variableCreate VariableCreate) ApiApiVariablesCreateRequest

type ApiApiVariablesDestroyRequest 

type ApiApiVariablesDestroyRequest struct {
	ApiService *VariablesAPIService
	// contains filtered or unexported fields
}

func (ApiApiVariablesDestroyRequest) Execute 

func (r ApiApiVariablesDestroyRequest) Execute() (*http.Response, error)

type ApiApiVariablesListRequest 

type ApiApiVariablesListRequest struct {
	ApiService *VariablesAPIService
	// contains filtered or unexported fields
}

func (ApiApiVariablesListRequest) Execute 

func (r ApiApiVariablesListRequest) Execute() ([]Variable, *http.Response, error)

type ApiApiVariablesRetrieveRequest 

type ApiApiVariablesRetrieveRequest struct {
	ApiService *VariablesAPIService
	// contains filtered or unexported fields
}

func (ApiApiVariablesRetrieveRequest) Execute 

func (r ApiApiVariablesRetrieveRequest) Execute() (*Variable, *http.Response, error)

type ApiApiVariablesUpdateRequest 

type ApiApiVariablesUpdateRequest struct {
	ApiService *VariablesAPIService
	// contains filtered or unexported fields
}

func (ApiApiVariablesUpdateRequest) Execute 

func (r ApiApiVariablesUpdateRequest) Execute() (*VariableGet, *http.Response, error)

func (ApiApiVariablesUpdateRequest) VariableCreate 

func (r ApiApiVariablesUpdateRequest) VariableCreate(variableCreate VariableCreate) ApiApiVariablesUpdateRequest

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

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

func NewNullableVariable 

func NewNullableVariable(val *Variable) *NullableVariable

func (NullableVariable) Get 

func (v NullableVariable) Get() *Variable

func (NullableVariable) IsSet 

func (v NullableVariable) IsSet() bool

func (NullableVariable) MarshalJSON 

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

func (*NullableVariable) Set 

func (v *NullableVariable) Set(val *Variable)

func (*NullableVariable) UnmarshalJSON 

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

func (*NullableVariable) Unset 

func (v *NullableVariable) Unset()

type NullableVariableCreate 

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

func NewNullableVariableCreate 

func NewNullableVariableCreate(val *VariableCreate) *NullableVariableCreate

func (NullableVariableCreate) Get 

func (v NullableVariableCreate) Get() *VariableCreate

func (NullableVariableCreate) IsSet 

func (v NullableVariableCreate) IsSet() bool

func (NullableVariableCreate) MarshalJSON 

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

func (*NullableVariableCreate) Set 

func (v *NullableVariableCreate) Set(val *VariableCreate)

func (*NullableVariableCreate) UnmarshalJSON 

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

func (*NullableVariableCreate) Unset 

func (v *NullableVariableCreate) Unset()

type NullableVariableGet 

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

func NewNullableVariableGet 

func NewNullableVariableGet(val *VariableGet) *NullableVariableGet

func (NullableVariableGet) Get 

func (v NullableVariableGet) Get() *VariableGet

func (NullableVariableGet) IsSet 

func (v NullableVariableGet) IsSet() bool

func (NullableVariableGet) MarshalJSON 

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

func (*NullableVariableGet) Set 

func (v *NullableVariableGet) Set(val *VariableGet)

func (*NullableVariableGet) UnmarshalJSON 

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

func (*NullableVariableGet) Unset 

func (v *NullableVariableGet) 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 Variable 

type Variable struct {
	Uuid       string    `json:"uuid"`
	Key        string    `json:"key"`
	Value      string    `json:"value"`
	Secret     bool      `json:"secret"`
	LastEditor string    `json:"last_editor"`
	CreatedAt  time.Time `json:"created_at"`
	UpdatedAt  time.Time `json:"updated_at"`
}

Variable struct for Variable

func NewVariable 

func NewVariable(uuid string, key string, value string, secret bool, lastEditor string, createdAt time.Time, updatedAt time.Time) *Variable

NewVariable instantiates a new Variable 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 NewVariableWithDefaults 

func NewVariableWithDefaults() *Variable

NewVariableWithDefaults instantiates a new Variable 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 (*Variable) GetCreatedAt 

func (o *Variable) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value

func (*Variable) GetCreatedAtOk 

func (o *Variable) GetCreatedAtOk() (*time.Time, bool)

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

func (*Variable) GetKey 

func (o *Variable) GetKey() string

GetKey returns the Key field value

func (*Variable) GetKeyOk 

func (o *Variable) GetKeyOk() (*string, bool)

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

func (*Variable) GetLastEditor 

func (o *Variable) GetLastEditor() string

GetLastEditor returns the LastEditor field value

func (*Variable) GetLastEditorOk 

func (o *Variable) GetLastEditorOk() (*string, bool)

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

func (*Variable) GetSecret 

func (o *Variable) GetSecret() bool

GetSecret returns the Secret field value

func (*Variable) GetSecretOk 

func (o *Variable) GetSecretOk() (*bool, bool)

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

func (*Variable) GetUpdatedAt 

func (o *Variable) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value

func (*Variable) GetUpdatedAtOk 

func (o *Variable) GetUpdatedAtOk() (*time.Time, bool)

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

func (*Variable) GetUuid 

func (o *Variable) GetUuid() string

GetUuid returns the Uuid field value

func (*Variable) GetUuidOk 

func (o *Variable) GetUuidOk() (*string, bool)

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

func (*Variable) GetValue 

func (o *Variable) GetValue() string

GetValue returns the Value field value

func (*Variable) GetValueOk 

func (o *Variable) GetValueOk() (*string, bool)

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

func (Variable) MarshalJSON 

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

func (*Variable) SetCreatedAt 

func (o *Variable) SetCreatedAt(v time.Time)

SetCreatedAt sets field value

func (*Variable) SetKey 

func (o *Variable) SetKey(v string)

SetKey sets field value

func (*Variable) SetLastEditor 

func (o *Variable) SetLastEditor(v string)

SetLastEditor sets field value

func (*Variable) SetSecret 

func (o *Variable) SetSecret(v bool)

SetSecret sets field value

func (*Variable) SetUpdatedAt 

func (o *Variable) SetUpdatedAt(v time.Time)

SetUpdatedAt sets field value

func (*Variable) SetUuid 

func (o *Variable) SetUuid(v string)

SetUuid sets field value

func (*Variable) SetValue 

func (o *Variable) SetValue(v string)

SetValue sets field value

func (Variable) ToMap 

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

type VariableCreate 

type VariableCreate struct {
	Key    string `json:"key"`
	Value  string `json:"value"`
	Secret *bool  `json:"secret,omitempty"`
}

VariableCreate struct for VariableCreate

func NewVariableCreate 

func NewVariableCreate(key string, value string) *VariableCreate

NewVariableCreate instantiates a new VariableCreate 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 NewVariableCreateWithDefaults 

func NewVariableCreateWithDefaults() *VariableCreate

NewVariableCreateWithDefaults instantiates a new VariableCreate 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 (*VariableCreate) GetKey 

func (o *VariableCreate) GetKey() string

GetKey returns the Key field value

func (*VariableCreate) GetKeyOk 

func (o *VariableCreate) GetKeyOk() (*string, bool)

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

func (*VariableCreate) GetSecret 

func (o *VariableCreate) GetSecret() bool

GetSecret returns the Secret field value if set, zero value otherwise.

func (*VariableCreate) GetSecretOk 

func (o *VariableCreate) GetSecretOk() (*bool, bool)

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

func (*VariableCreate) GetValue 

func (o *VariableCreate) GetValue() string

GetValue returns the Value field value

func (*VariableCreate) GetValueOk 

func (o *VariableCreate) GetValueOk() (*string, bool)

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

func (*VariableCreate) HasSecret 

func (o *VariableCreate) HasSecret() bool

HasSecret returns a boolean if a field has been set.

func (VariableCreate) MarshalJSON 

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

func (*VariableCreate) SetKey 

func (o *VariableCreate) SetKey(v string)

SetKey sets field value

func (*VariableCreate) SetSecret 

func (o *VariableCreate) SetSecret(v bool)

SetSecret gets a reference to the given bool and assigns it to the Secret field.

func (*VariableCreate) SetValue 

func (o *VariableCreate) SetValue(v string)

SetValue sets field value

func (VariableCreate) ToMap 

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

type VariableGet 

type VariableGet struct {
	Uuid string `json:"uuid"`
	Key  string `json:"key"`
	// Given the *incoming* primitive data, return the value for this field that should be validated and transformed to a native value.
	Value      string    `json:"value"`
	Secret     bool      `json:"secret"`
	LastEditor string    `json:"last_editor"`
	CreatedAt  time.Time `json:"created_at"`
	UpdatedAt  time.Time `json:"updated_at"`
}

VariableGet struct for VariableGet

func NewVariableGet 

func NewVariableGet(uuid string, key string, value string, secret bool, lastEditor string, createdAt time.Time, updatedAt time.Time) *VariableGet

NewVariableGet instantiates a new VariableGet 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 NewVariableGetWithDefaults 

func NewVariableGetWithDefaults() *VariableGet

NewVariableGetWithDefaults instantiates a new VariableGet 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 (*VariableGet) GetCreatedAt 

func (o *VariableGet) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value

func (*VariableGet) GetCreatedAtOk 

func (o *VariableGet) GetCreatedAtOk() (*time.Time, bool)

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

func (*VariableGet) GetKey 

func (o *VariableGet) GetKey() string

GetKey returns the Key field value

func (*VariableGet) GetKeyOk 

func (o *VariableGet) GetKeyOk() (*string, bool)

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

func (*VariableGet) GetLastEditor 

func (o *VariableGet) GetLastEditor() string

GetLastEditor returns the LastEditor field value

func (*VariableGet) GetLastEditorOk 

func (o *VariableGet) GetLastEditorOk() (*string, bool)

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

func (*VariableGet) GetSecret 

func (o *VariableGet) GetSecret() bool

GetSecret returns the Secret field value

func (*VariableGet) GetSecretOk 

func (o *VariableGet) GetSecretOk() (*bool, bool)

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

func (*VariableGet) GetUpdatedAt 

func (o *VariableGet) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value

func (*VariableGet) GetUpdatedAtOk 

func (o *VariableGet) GetUpdatedAtOk() (*time.Time, bool)

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

func (*VariableGet) GetUuid 

func (o *VariableGet) GetUuid() string

GetUuid returns the Uuid field value

func (*VariableGet) GetUuidOk 

func (o *VariableGet) GetUuidOk() (*string, bool)

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

func (*VariableGet) GetValue 

func (o *VariableGet) GetValue() string

GetValue returns the Value field value

func (*VariableGet) GetValueOk 

func (o *VariableGet) GetValueOk() (*string, bool)

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

func (VariableGet) MarshalJSON 

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

func (*VariableGet) SetCreatedAt 

func (o *VariableGet) SetCreatedAt(v time.Time)

SetCreatedAt sets field value

func (*VariableGet) SetKey 

func (o *VariableGet) SetKey(v string)

SetKey sets field value

func (*VariableGet) SetLastEditor 

func (o *VariableGet) SetLastEditor(v string)

SetLastEditor sets field value

func (*VariableGet) SetSecret 

func (o *VariableGet) SetSecret(v bool)

SetSecret sets field value

func (*VariableGet) SetUpdatedAt 

func (o *VariableGet) SetUpdatedAt(v time.Time)

SetUpdatedAt sets field value

func (*VariableGet) SetUuid 

func (o *VariableGet) SetUuid(v string)

SetUuid sets field value

func (*VariableGet) SetValue 

func (o *VariableGet) SetValue(v string)

SetValue sets field value

func (VariableGet) ToMap 

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

type VariablesAPIService added in v0.93.0 

type VariablesAPIService service

VariablesAPIService VariablesAPI service

func (*VariablesAPIService) ApiVariablesCreate added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesCreate(ctx context.Context) ApiApiVariablesCreateRequest

ApiVariablesCreate /variables

Create a new Variable. <br><ul><li>If the attribute "secret" is informed with value "true" in request payload the Variable value will be secret and no longer viewable after creation.</li><li>If the attribute "secret" is not informed the Variable value will be considered as not secret by default.</li></ul> 

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

func (*VariablesAPIService) ApiVariablesCreateExecute added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesCreateExecute(r ApiApiVariablesCreateRequest) (*VariableGet, *http.Response, error)

Execute executes the request 

@return VariableGet

func (*VariablesAPIService) ApiVariablesDestroy added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesDestroy(ctx context.Context, uuid string) ApiApiVariablesDestroyRequest

ApiVariablesDestroy /variables/:uuid

Delete a Variable by it's UUID 

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

func (*VariablesAPIService) ApiVariablesDestroyExecute added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesDestroyExecute(r ApiApiVariablesDestroyRequest) (*http.Response, error)

Execute executes the request

func (*VariablesAPIService) ApiVariablesList added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesList(ctx context.Context) ApiApiVariablesListRequest

ApiVariablesList /variables

List all user's Variables. 

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

func (*VariablesAPIService) ApiVariablesListExecute added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesListExecute(r ApiApiVariablesListRequest) ([]Variable, *http.Response, error)

Execute executes the request 

@return []Variable

func (*VariablesAPIService) ApiVariablesRetrieve added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesRetrieve(ctx context.Context, uuid string) ApiApiVariablesRetrieveRequest

ApiVariablesRetrieve /variables/:uuid

Retrieve all data for a Variable by it's UUID 

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

func (*VariablesAPIService) ApiVariablesRetrieveExecute added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesRetrieveExecute(r ApiApiVariablesRetrieveRequest) (*Variable, *http.Response, error)

Execute executes the request 

@return Variable

func (*VariablesAPIService) ApiVariablesUpdate added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesUpdate(ctx context.Context, uuid string) ApiApiVariablesUpdateRequest

ApiVariablesUpdate /variables/:uuid

Update variable attributes by it's UUID. Keep the Variable UUID but overwrite all editable attributes. 

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

func (*VariablesAPIService) ApiVariablesUpdateExecute added in v0.93.0 

func (a *VariablesAPIService) ApiVariablesUpdateExecute(r ApiApiVariablesUpdateRequest) (*VariableGet, *http.Response, error)

Execute executes the request 

@return VariableGet

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.