stackstate_api

package
v0.9.8-0...-1472f5b Latest Latest
Warning

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

 Go to latest Published: Oct 30, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

README

Go API client for stackstate_api

StackState's Admin API specification

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: 0.0.1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://stackstate.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 stackstate_api "gitlab.com/stackvista/stackstate-cli2"

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
RetentionApi GetRetentionEpoch Get /retention/currentEpoch Get retention epoch
RetentionApi GetRetentionWindow Get /retention/window Get retention window
RetentionApi RemoveExpiredData Post /retention/removeExpiredData Remove expired data from StackGraph
RetentionApi SetRetentionWindow Post /retention/window Set retention window

Documentation For Models

Documentation For Authorization

ApiToken
  • Type: API key
  • API key parameter name: X-API-Token
  • Location: HTTP header

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

ServiceBearer
  • Type: API key
  • API key parameter name: X-API-ServiceBearer
  • Location: HTTP header

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

ServiceToken
  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

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

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

info@stackstate.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 {
	RetentionApi RetentionApi
	// contains filtered or unexported fields
}

APIClient manages communication with the StackState Admin API API v0.0.1 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

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

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

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

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

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

type APIResponse 

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

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

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

type ApiGetRetentionEpochRequest 

type ApiGetRetentionEpochRequest struct {
	ApiService RetentionApi
	// contains filtered or unexported fields
}

func (ApiGetRetentionEpochRequest) Execute 

func (r ApiGetRetentionEpochRequest) Execute() (*EpochTx, *http.Response, error)

type ApiGetRetentionWindowRequest 

type ApiGetRetentionWindowRequest struct {
	ApiService RetentionApi
	// contains filtered or unexported fields
}

func (ApiGetRetentionWindowRequest) Execute 

func (r ApiGetRetentionWindowRequest) Execute() (*WindowMs, *http.Response, error)

type ApiRemoveExpiredDataRequest 

type ApiRemoveExpiredDataRequest struct {
	ApiService RetentionApi
	// contains filtered or unexported fields
}

func (ApiRemoveExpiredDataRequest) Execute 

func (r ApiRemoveExpiredDataRequest) Execute() (*RemovalProgress, *http.Response, error)

func (ApiRemoveExpiredDataRequest) ExpireImmediatelyAndRestart 

func (r ApiRemoveExpiredDataRequest) ExpireImmediatelyAndRestart(expireImmediatelyAndRestart bool) ApiRemoveExpiredDataRequest

If set, makes StackState remove expired data immediately and restart afterwards.

type ApiSetRetentionWindowRequest 

type ApiSetRetentionWindowRequest struct {
	ApiService RetentionApi
	// contains filtered or unexported fields
}

func (ApiSetRetentionWindowRequest) Execute 

func (r ApiSetRetentionWindowRequest) Execute() (*WindowMs, *http.Response, error)

func (ApiSetRetentionWindowRequest) ScheduleRemoval 

func (r ApiSetRetentionWindowRequest) ScheduleRemoval(scheduleRemoval bool) ApiSetRetentionWindowRequest

If set, makes StackState schedule removal of expired data according to the set retention window.

func (ApiSetRetentionWindowRequest) WindowMs 

func (r ApiSetRetentionWindowRequest) WindowMs(windowMs WindowMs) ApiSetRetentionWindowRequest

The new retention window value.

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
	OnPreCallAPI     func(*http.Request)
	OnPostCallAPI    func(*http.Request)
}

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 EpochTx 

type EpochTx struct {
	EpochTx int64 `json:"epochTx"`
}

EpochTx struct for EpochTx

func NewEpochTx 

func NewEpochTx(epochTx int64) *EpochTx

NewEpochTx instantiates a new EpochTx 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 NewEpochTxWithDefaults 

func NewEpochTxWithDefaults() *EpochTx

NewEpochTxWithDefaults instantiates a new EpochTx 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 (*EpochTx) GetEpochTx 

func (o *EpochTx) GetEpochTx() int64

GetEpochTx returns the EpochTx field value

func (*EpochTx) GetEpochTxOk 

func (o *EpochTx) GetEpochTxOk() (*int64, bool)

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

func (EpochTx) MarshalJSON 

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

func (*EpochTx) SetEpochTx 

func (o *EpochTx) SetEpochTx(v int64)

SetEpochTx sets field value

type GenericApiError 

type GenericApiError struct {
	Type      string `json:"_type"`
	Message   string `json:"message"`
	ErrorCode *int64 `json:"errorCode,omitempty"`
}

GenericApiError struct for GenericApiError

func NewGenericApiError 

func NewGenericApiError(type_ string, message string) *GenericApiError

NewGenericApiError instantiates a new GenericApiError 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 NewGenericApiErrorWithDefaults 

func NewGenericApiErrorWithDefaults() *GenericApiError

NewGenericApiErrorWithDefaults instantiates a new GenericApiError 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 (*GenericApiError) GetErrorCode 

func (o *GenericApiError) GetErrorCode() int64

GetErrorCode returns the ErrorCode field value if set, zero value otherwise.

func (*GenericApiError) GetErrorCodeOk 

func (o *GenericApiError) GetErrorCodeOk() (*int64, bool)

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

func (*GenericApiError) GetMessage 

func (o *GenericApiError) GetMessage() string

GetMessage returns the Message field value

func (*GenericApiError) GetMessageOk 

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

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

func (*GenericApiError) GetType 

func (o *GenericApiError) GetType() string

GetType returns the Type field value

func (*GenericApiError) GetTypeOk 

func (o *GenericApiError) GetTypeOk() (*string, bool)

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

func (*GenericApiError) HasErrorCode 

func (o *GenericApiError) HasErrorCode() bool

HasErrorCode returns a boolean if a field has been set.

func (GenericApiError) MarshalJSON 

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

func (*GenericApiError) SetErrorCode 

func (o *GenericApiError) SetErrorCode(v int64)

SetErrorCode gets a reference to the given int64 and assigns it to the ErrorCode field.

func (*GenericApiError) SetMessage 

func (o *GenericApiError) SetMessage(v string)

SetMessage sets field value

func (*GenericApiError) SetType 

func (o *GenericApiError) SetType(v string)

SetType sets field value

type GenericErrorsResponse 

type GenericErrorsResponse struct {
	Type            *string           `json:"_type,omitempty"`
	TrackingKey     string            `json:"trackingKey"`
	ServerTimestamp int64             `json:"serverTimestamp"`
	Errors          []GenericApiError `json:"errors"`
}

GenericErrorsResponse struct for GenericErrorsResponse

func NewGenericErrorsResponse 

func NewGenericErrorsResponse(trackingKey string, serverTimestamp int64, errors []GenericApiError) *GenericErrorsResponse

NewGenericErrorsResponse instantiates a new GenericErrorsResponse 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 NewGenericErrorsResponseWithDefaults 

func NewGenericErrorsResponseWithDefaults() *GenericErrorsResponse

NewGenericErrorsResponseWithDefaults instantiates a new GenericErrorsResponse 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 (*GenericErrorsResponse) GetErrors 

func (o *GenericErrorsResponse) GetErrors() []GenericApiError

GetErrors returns the Errors field value

func (*GenericErrorsResponse) GetErrorsOk 

func (o *GenericErrorsResponse) GetErrorsOk() ([]GenericApiError, bool)

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

func (*GenericErrorsResponse) GetServerTimestamp 

func (o *GenericErrorsResponse) GetServerTimestamp() int64

GetServerTimestamp returns the ServerTimestamp field value

func (*GenericErrorsResponse) GetServerTimestampOk 

func (o *GenericErrorsResponse) GetServerTimestampOk() (*int64, bool)

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

func (*GenericErrorsResponse) GetTrackingKey 

func (o *GenericErrorsResponse) GetTrackingKey() string

GetTrackingKey returns the TrackingKey field value

func (*GenericErrorsResponse) GetTrackingKeyOk 

func (o *GenericErrorsResponse) GetTrackingKeyOk() (*string, bool)

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

func (*GenericErrorsResponse) GetType 

func (o *GenericErrorsResponse) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*GenericErrorsResponse) GetTypeOk 

func (o *GenericErrorsResponse) GetTypeOk() (*string, bool)

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

func (*GenericErrorsResponse) HasType 

func (o *GenericErrorsResponse) HasType() bool

HasType returns a boolean if a field has been set.

func (GenericErrorsResponse) MarshalJSON 

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

func (*GenericErrorsResponse) SetErrors 

func (o *GenericErrorsResponse) SetErrors(v []GenericApiError)

SetErrors sets field value

func (*GenericErrorsResponse) SetServerTimestamp 

func (o *GenericErrorsResponse) SetServerTimestamp(v int64)

SetServerTimestamp sets field value

func (*GenericErrorsResponse) SetTrackingKey 

func (o *GenericErrorsResponse) SetTrackingKey(v string)

SetTrackingKey sets field value

func (*GenericErrorsResponse) SetType 

func (o *GenericErrorsResponse) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

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 GetRetentionEpochCall 

type GetRetentionEpochCall struct {
}

type GetRetentionEpochMockResponse 

type GetRetentionEpochMockResponse struct {
	Result   EpochTx
	Response *http.Response
	Error    error
}

type GetRetentionWindowCall 

type GetRetentionWindowCall struct {
}

type GetRetentionWindowMockResponse 

type GetRetentionWindowMockResponse struct {
	Result   WindowMs
	Response *http.Response
	Error    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 NullableEpochTx 

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

func NewNullableEpochTx 

func NewNullableEpochTx(val *EpochTx) *NullableEpochTx

func (NullableEpochTx) Get 

func (v NullableEpochTx) Get() *EpochTx

func (NullableEpochTx) IsSet 

func (v NullableEpochTx) IsSet() bool

func (NullableEpochTx) MarshalJSON 

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

func (*NullableEpochTx) Set 

func (v *NullableEpochTx) Set(val *EpochTx)

func (*NullableEpochTx) UnmarshalJSON 

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

func (*NullableEpochTx) Unset 

func (v *NullableEpochTx) 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 NullableGenericApiError 

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

func NewNullableGenericApiError 

func NewNullableGenericApiError(val *GenericApiError) *NullableGenericApiError

func (NullableGenericApiError) Get 

func (v NullableGenericApiError) Get() *GenericApiError

func (NullableGenericApiError) IsSet 

func (v NullableGenericApiError) IsSet() bool

func (NullableGenericApiError) MarshalJSON 

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

func (*NullableGenericApiError) Set 

func (v *NullableGenericApiError) Set(val *GenericApiError)

func (*NullableGenericApiError) UnmarshalJSON 

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

func (*NullableGenericApiError) Unset 

func (v *NullableGenericApiError) Unset()

type NullableGenericErrorsResponse 

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

func NewNullableGenericErrorsResponse 

func NewNullableGenericErrorsResponse(val *GenericErrorsResponse) *NullableGenericErrorsResponse

func (NullableGenericErrorsResponse) Get 

func (v NullableGenericErrorsResponse) Get() *GenericErrorsResponse

func (NullableGenericErrorsResponse) IsSet 

func (v NullableGenericErrorsResponse) IsSet() bool

func (NullableGenericErrorsResponse) MarshalJSON 

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

func (*NullableGenericErrorsResponse) Set 

func (v *NullableGenericErrorsResponse) Set(val *GenericErrorsResponse)

func (*NullableGenericErrorsResponse) UnmarshalJSON 

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

func (*NullableGenericErrorsResponse) Unset 

func (v *NullableGenericErrorsResponse) 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 NullableRemovalProgress 

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

func NewNullableRemovalProgress 

func NewNullableRemovalProgress(val *RemovalProgress) *NullableRemovalProgress

func (NullableRemovalProgress) Get 

func (v NullableRemovalProgress) Get() *RemovalProgress

func (NullableRemovalProgress) IsSet 

func (v NullableRemovalProgress) IsSet() bool

func (NullableRemovalProgress) MarshalJSON 

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

func (*NullableRemovalProgress) Set 

func (v *NullableRemovalProgress) Set(val *RemovalProgress)

func (*NullableRemovalProgress) UnmarshalJSON 

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

func (*NullableRemovalProgress) Unset 

func (v *NullableRemovalProgress) Unset()

type NullableRemovalProgressProgress 

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

func NewNullableRemovalProgressProgress 

func NewNullableRemovalProgressProgress(val *RemovalProgressProgress) *NullableRemovalProgressProgress

func (NullableRemovalProgressProgress) Get 

func (v NullableRemovalProgressProgress) Get() *RemovalProgressProgress

func (NullableRemovalProgressProgress) IsSet 

func (v NullableRemovalProgressProgress) IsSet() bool

func (NullableRemovalProgressProgress) MarshalJSON 

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

func (*NullableRemovalProgressProgress) Set 

func (v *NullableRemovalProgressProgress) Set(val *RemovalProgressProgress)

func (*NullableRemovalProgressProgress) UnmarshalJSON 

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

func (*NullableRemovalProgressProgress) Unset 

func (v *NullableRemovalProgressProgress) 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 NullableWindowMs 

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

func NewNullableWindowMs 

func NewNullableWindowMs(val *WindowMs) *NullableWindowMs

func (NullableWindowMs) Get 

func (v NullableWindowMs) Get() *WindowMs

func (NullableWindowMs) IsSet 

func (v NullableWindowMs) IsSet() bool

func (NullableWindowMs) MarshalJSON 

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

func (*NullableWindowMs) Set 

func (v *NullableWindowMs) Set(val *WindowMs)

func (*NullableWindowMs) UnmarshalJSON 

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

func (*NullableWindowMs) Unset 

func (v *NullableWindowMs) Unset()

type RemovalProgress 

type RemovalProgress struct {
	Progress RemovalProgressProgress `json:"progress"`
}

RemovalProgress struct for RemovalProgress

func NewRemovalProgress 

func NewRemovalProgress(progress RemovalProgressProgress) *RemovalProgress

NewRemovalProgress instantiates a new RemovalProgress 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 NewRemovalProgressWithDefaults 

func NewRemovalProgressWithDefaults() *RemovalProgress

NewRemovalProgressWithDefaults instantiates a new RemovalProgress 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 (*RemovalProgress) GetProgress 

func (o *RemovalProgress) GetProgress() RemovalProgressProgress

GetProgress returns the Progress field value

func (*RemovalProgress) GetProgressOk 

func (o *RemovalProgress) GetProgressOk() (*RemovalProgressProgress, bool)

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

func (RemovalProgress) MarshalJSON 

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

func (*RemovalProgress) SetProgress 

func (o *RemovalProgress) SetProgress(v RemovalProgressProgress)

SetProgress sets field value

type RemovalProgressProgress 

type RemovalProgressProgress struct {
	Type string `json:"_type"`
}

RemovalProgressProgress struct for RemovalProgressProgress

func NewRemovalProgressProgress 

func NewRemovalProgressProgress(type_ string) *RemovalProgressProgress

NewRemovalProgressProgress instantiates a new RemovalProgressProgress 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 NewRemovalProgressProgressWithDefaults 

func NewRemovalProgressProgressWithDefaults() *RemovalProgressProgress

NewRemovalProgressProgressWithDefaults instantiates a new RemovalProgressProgress 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 (*RemovalProgressProgress) GetType 

func (o *RemovalProgressProgress) GetType() string

GetType returns the Type field value

func (*RemovalProgressProgress) GetTypeOk 

func (o *RemovalProgressProgress) GetTypeOk() (*string, bool)

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

func (RemovalProgressProgress) MarshalJSON 

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

func (*RemovalProgressProgress) SetType 

func (o *RemovalProgressProgress) SetType(v string)

SetType sets field value

type RemoveExpiredDataCall 

type RemoveExpiredDataCall struct {
	PexpireImmediatelyAndRestart *bool
}

type RemoveExpiredDataMockResponse 

type RemoveExpiredDataMockResponse struct {
	Result   RemovalProgress
	Response *http.Response
	Error    error
}

type RetentionApi 

type RetentionApi interface {

	/*
		GetRetentionEpoch Get retention epoch

		Get StackGraph retention epoch.

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

	// GetRetentionEpochExecute executes the request
	//  @return EpochTx
	GetRetentionEpochExecute(r ApiGetRetentionEpochRequest) (*EpochTx, *http.Response, error)

	/*
		GetRetentionWindow Get retention window

		Get StackGraph retention window.

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

	// GetRetentionWindowExecute executes the request
	//  @return WindowMs
	GetRetentionWindowExecute(r ApiGetRetentionWindowRequest) (*WindowMs, *http.Response, error)

	/*
		RemoveExpiredData Remove expired data from StackGraph

		Either schedule removal or immediately remove expired data from StackGraph

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

	// RemoveExpiredDataExecute executes the request
	//  @return RemovalProgress
	RemoveExpiredDataExecute(r ApiRemoveExpiredDataRequest) (*RemovalProgress, *http.Response, error)

	/*
		SetRetentionWindow Set retention window

		Set StackGraph retention window and optionally schedule data removal.

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

	// SetRetentionWindowExecute executes the request
	//  @return WindowMs
	SetRetentionWindowExecute(r ApiSetRetentionWindowRequest) (*WindowMs, *http.Response, error)
}

type RetentionApiMock 

type RetentionApiMock struct {
	GetRetentionEpochCalls     *[]GetRetentionEpochCall
	GetRetentionEpochResponse  GetRetentionEpochMockResponse
	GetRetentionWindowCalls    *[]GetRetentionWindowCall
	GetRetentionWindowResponse GetRetentionWindowMockResponse
	RemoveExpiredDataCalls     *[]RemoveExpiredDataCall
	RemoveExpiredDataResponse  RemoveExpiredDataMockResponse
	SetRetentionWindowCalls    *[]SetRetentionWindowCall
	SetRetentionWindowResponse SetRetentionWindowMockResponse
}

func NewRetentionApiMock 

func NewRetentionApiMock() RetentionApiMock

func (RetentionApiMock) GetRetentionEpoch 

func (mock RetentionApiMock) GetRetentionEpoch(ctx context.Context) ApiGetRetentionEpochRequest

func (RetentionApiMock) GetRetentionEpochExecute 

func (mock RetentionApiMock) GetRetentionEpochExecute(r ApiGetRetentionEpochRequest) (*EpochTx, *http.Response, error)

func (RetentionApiMock) GetRetentionWindow 

func (mock RetentionApiMock) GetRetentionWindow(ctx context.Context) ApiGetRetentionWindowRequest

func (RetentionApiMock) GetRetentionWindowExecute 

func (mock RetentionApiMock) GetRetentionWindowExecute(r ApiGetRetentionWindowRequest) (*WindowMs, *http.Response, error)

func (RetentionApiMock) RemoveExpiredData 

func (mock RetentionApiMock) RemoveExpiredData(ctx context.Context) ApiRemoveExpiredDataRequest

func (RetentionApiMock) RemoveExpiredDataExecute 

func (mock RetentionApiMock) RemoveExpiredDataExecute(r ApiRemoveExpiredDataRequest) (*RemovalProgress, *http.Response, error)

func (RetentionApiMock) SetRetentionWindow 

func (mock RetentionApiMock) SetRetentionWindow(ctx context.Context) ApiSetRetentionWindowRequest

func (RetentionApiMock) SetRetentionWindowExecute 

func (mock RetentionApiMock) SetRetentionWindowExecute(r ApiSetRetentionWindowRequest) (*WindowMs, *http.Response, error)

type RetentionApiService 

type RetentionApiService service

RetentionApiService RetentionApi service

func (*RetentionApiService) GetRetentionEpoch 

func (a *RetentionApiService) GetRetentionEpoch(ctx context.Context) ApiGetRetentionEpochRequest

GetRetentionEpoch Get retention epoch

Get StackGraph retention epoch. 

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

func (*RetentionApiService) GetRetentionEpochExecute 

func (a *RetentionApiService) GetRetentionEpochExecute(r ApiGetRetentionEpochRequest) (*EpochTx, *http.Response, error)

Execute executes the request 

@return EpochTx

func (*RetentionApiService) GetRetentionWindow 

func (a *RetentionApiService) GetRetentionWindow(ctx context.Context) ApiGetRetentionWindowRequest

GetRetentionWindow Get retention window

Get StackGraph retention window. 

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

func (*RetentionApiService) GetRetentionWindowExecute 

func (a *RetentionApiService) GetRetentionWindowExecute(r ApiGetRetentionWindowRequest) (*WindowMs, *http.Response, error)

Execute executes the request 

@return WindowMs

func (*RetentionApiService) RemoveExpiredData 

func (a *RetentionApiService) RemoveExpiredData(ctx context.Context) ApiRemoveExpiredDataRequest

RemoveExpiredData Remove expired data from StackGraph

Either schedule removal or immediately remove expired data from StackGraph 

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

func (*RetentionApiService) RemoveExpiredDataExecute 

func (a *RetentionApiService) RemoveExpiredDataExecute(r ApiRemoveExpiredDataRequest) (*RemovalProgress, *http.Response, error)

Execute executes the request 

@return RemovalProgress

func (*RetentionApiService) SetRetentionWindow 

func (a *RetentionApiService) SetRetentionWindow(ctx context.Context) ApiSetRetentionWindowRequest

SetRetentionWindow Set retention window

Set StackGraph retention window and optionally schedule data removal. 

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

func (*RetentionApiService) SetRetentionWindowExecute 

func (a *RetentionApiService) SetRetentionWindowExecute(r ApiSetRetentionWindowRequest) (*WindowMs, *http.Response, error)

Execute executes the request 

@return WindowMs

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 SetRetentionWindowCall 

type SetRetentionWindowCall struct {
	PwindowMs        *WindowMs
	PscheduleRemoval *bool
}

type SetRetentionWindowMockResponse 

type SetRetentionWindowMockResponse struct {
	Result   WindowMs
	Response *http.Response
	Error    error
}

type WindowMs 

type WindowMs struct {
	WindowMs int64 `json:"windowMs"`
}

WindowMs struct for WindowMs

func NewWindowMs 

func NewWindowMs(windowMs int64) *WindowMs

NewWindowMs instantiates a new WindowMs 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 NewWindowMsWithDefaults 

func NewWindowMsWithDefaults() *WindowMs

NewWindowMsWithDefaults instantiates a new WindowMs 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 (*WindowMs) GetWindowMs 

func (o *WindowMs) GetWindowMs() int64

GetWindowMs returns the WindowMs field value

func (*WindowMs) GetWindowMsOk 

func (o *WindowMs) GetWindowMsOk() (*int64, bool)

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

func (WindowMs) MarshalJSON 

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

func (*WindowMs) SetWindowMs 

func (o *WindowMs) SetWindowMs(v int64)

SetWindowMs 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.