client

package module
v0.40.8 Latest Latest
Warning

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

 Go to latest Published: Jul 8, 2024 License: Apache-2.0 Imports: 20 Imported by: 1

README

ory/oathkeeper-client-go

This is the official Ory Oathkeeper SDK for go.

Ory Self-Hosted

This SDK is for use with self-hosted Ory Oathkeeper. If you are developing against Ory Network, please use the Ory Network SDK.

Please do not make any pull requests against this repository! Its contents are fully auto-generated by the ory/sdk repository. Any changes to this repository will be overwritten on the next CI run!

Installation

package repository is missing, please open an issue about this.

Documentation

Generation

This code base, including this README, is auto-generated using OpenAPI Generator. If you find bugs in the SDK please check if there is an open issue at OpenAPITools/openapi-generator or ory/sdk already before opening an issue here.

Feedback

If you have feedback on how to improve the Ory SDK or are looking to contribute, please open an issue in ory/sdk to discuss your ideas.

Thanks for being a part of the Ory community!

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// 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 added in v0.40.8 

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 {
	ApiAPI ApiAPI

	HealthAPI HealthAPI

	VersionAPI VersionAPI
	// contains filtered or unexported fields
}

APIClient manages communication with the ORY Oathkeeper API vv0.40.8 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 ApiAPI added in v0.40.8 

type ApiAPI interface {

	/*
		Decisions Access Control Decision API

		> This endpoint works with all HTTP Methods (GET, POST, PUT, ...) and matches every path prefixed with /decisions.

	This endpoint mirrors the proxy capability of ORY Oathkeeper's proxy functionality but instead of forwarding the
	request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden)
	status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more.

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

	// DecisionsExecute executes the request
	DecisionsExecute(r ApiAPIDecisionsRequest) (*http.Response, error)

	/*
		GetRule Retrieve a Rule

		Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.

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

	// GetRuleExecute executes the request
	//  @return Rule
	GetRuleExecute(r ApiAPIGetRuleRequest) (*Rule, *http.Response, error)

	/*
		GetWellKnownJSONWebKeys Lists Cryptographic Keys

		This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.

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

	// GetWellKnownJSONWebKeysExecute executes the request
	//  @return JsonWebKeySet
	GetWellKnownJSONWebKeysExecute(r ApiAPIGetWellKnownJSONWebKeysRequest) (*JsonWebKeySet, *http.Response, error)

	/*
		ListRules List All Rules

		This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full
	view of what rules you have currently in place.

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

	// ListRulesExecute executes the request
	//  @return []Rule
	ListRulesExecute(r ApiAPIListRulesRequest) ([]Rule, *http.Response, error)
}

type ApiAPIDecisionsRequest added in v0.40.8 

type ApiAPIDecisionsRequest struct {
	ApiService ApiAPI
	// contains filtered or unexported fields
}

func (ApiAPIDecisionsRequest) Execute added in v0.40.8 

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

type ApiAPIGetRuleRequest added in v0.40.8 

type ApiAPIGetRuleRequest struct {
	ApiService ApiAPI
	// contains filtered or unexported fields
}

func (ApiAPIGetRuleRequest) Execute added in v0.40.8 

func (r ApiAPIGetRuleRequest) Execute() (*Rule, *http.Response, error)

type ApiAPIGetWellKnownJSONWebKeysRequest added in v0.40.8 

type ApiAPIGetWellKnownJSONWebKeysRequest struct {
	ApiService ApiAPI
	// contains filtered or unexported fields
}

func (ApiAPIGetWellKnownJSONWebKeysRequest) Execute added in v0.40.8 

func (r ApiAPIGetWellKnownJSONWebKeysRequest) Execute() (*JsonWebKeySet, *http.Response, error)

type ApiAPIListRulesRequest added in v0.40.8 

type ApiAPIListRulesRequest struct {
	ApiService ApiAPI
	// contains filtered or unexported fields
}

func (ApiAPIListRulesRequest) Execute added in v0.40.8 

func (r ApiAPIListRulesRequest) Execute() ([]Rule, *http.Response, error)

func (ApiAPIListRulesRequest) Limit added in v0.40.8 

func (r ApiAPIListRulesRequest) Limit(limit int64) ApiAPIListRulesRequest

The maximum amount of rules returned.

func (ApiAPIListRulesRequest) Offset added in v0.40.8 

func (r ApiAPIListRulesRequest) Offset(offset int64) ApiAPIListRulesRequest

The offset from where to start looking.

type ApiAPIService added in v0.40.8 

type ApiAPIService service

ApiAPIService ApiAPI service

func (*ApiAPIService) Decisions added in v0.40.8 

func (a *ApiAPIService) Decisions(ctx context.Context) ApiAPIDecisionsRequest

Decisions Access Control Decision API

> This endpoint works with all HTTP Methods (GET, POST, PUT, ...) and matches every path prefixed with /decisions.

This endpoint mirrors the proxy capability of ORY Oathkeeper's proxy functionality but instead of forwarding the request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden) status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more. 

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

func (*ApiAPIService) DecisionsExecute added in v0.40.8 

func (a *ApiAPIService) DecisionsExecute(r ApiAPIDecisionsRequest) (*http.Response, error)

Execute executes the request

func (*ApiAPIService) GetRule added in v0.40.8 

func (a *ApiAPIService) GetRule(ctx context.Context, id string) ApiAPIGetRuleRequest

GetRule Retrieve a Rule

Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error. 

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

func (*ApiAPIService) GetRuleExecute added in v0.40.8 

func (a *ApiAPIService) GetRuleExecute(r ApiAPIGetRuleRequest) (*Rule, *http.Response, error)

Execute executes the request 

@return Rule

func (*ApiAPIService) GetWellKnownJSONWebKeys added in v0.40.8 

func (a *ApiAPIService) GetWellKnownJSONWebKeys(ctx context.Context) ApiAPIGetWellKnownJSONWebKeysRequest

GetWellKnownJSONWebKeys Lists Cryptographic Keys

This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens. 

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

func (*ApiAPIService) GetWellKnownJSONWebKeysExecute added in v0.40.8 

func (a *ApiAPIService) GetWellKnownJSONWebKeysExecute(r ApiAPIGetWellKnownJSONWebKeysRequest) (*JsonWebKeySet, *http.Response, error)

Execute executes the request 

@return JsonWebKeySet

func (*ApiAPIService) ListRules added in v0.40.8 

func (a *ApiAPIService) ListRules(ctx context.Context) ApiAPIListRulesRequest

ListRules List All Rules

This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full view of what rules you have currently in place. 

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

func (*ApiAPIService) ListRulesExecute added in v0.40.8 

func (a *ApiAPIService) ListRulesExecute(r ApiAPIListRulesRequest) ([]Rule, *http.Response, error)

Execute executes the request 

@return []Rule

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 GenericError added in v0.40.2 

type GenericError struct {
	Code                 *int64                              `json:"code,omitempty"`
	Details              []map[string]map[string]interface{} `json:"details,omitempty"`
	Message              *string                             `json:"message,omitempty"`
	Reason               *string                             `json:"reason,omitempty"`
	Request              *string                             `json:"request,omitempty"`
	Status               *string                             `json:"status,omitempty"`
	AdditionalProperties map[string]interface{}
}

GenericError The standard error format

func NewGenericError added in v0.40.2 

func NewGenericError() *GenericError

NewGenericError instantiates a new GenericError 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 NewGenericErrorWithDefaults added in v0.40.2 

func NewGenericErrorWithDefaults() *GenericError

NewGenericErrorWithDefaults instantiates a new GenericError 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 (*GenericError) GetCode added in v0.40.2 

func (o *GenericError) GetCode() int64

GetCode returns the Code field value if set, zero value otherwise.

func (*GenericError) GetCodeOk added in v0.40.2 

func (o *GenericError) GetCodeOk() (*int64, bool)

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

func (*GenericError) GetDetails added in v0.40.2 

func (o *GenericError) GetDetails() []map[string]map[string]interface{}

GetDetails returns the Details field value if set, zero value otherwise.

func (*GenericError) GetDetailsOk added in v0.40.2 

func (o *GenericError) GetDetailsOk() ([]map[string]map[string]interface{}, bool)

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

func (*GenericError) GetMessage added in v0.40.2 

func (o *GenericError) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*GenericError) GetMessageOk added in v0.40.2 

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

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

func (*GenericError) GetReason added in v0.40.2 

func (o *GenericError) GetReason() string

GetReason returns the Reason field value if set, zero value otherwise.

func (*GenericError) GetReasonOk added in v0.40.2 

func (o *GenericError) GetReasonOk() (*string, bool)

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

func (*GenericError) GetRequest added in v0.40.2 

func (o *GenericError) GetRequest() string

GetRequest returns the Request field value if set, zero value otherwise.

func (*GenericError) GetRequestOk added in v0.40.2 

func (o *GenericError) GetRequestOk() (*string, bool)

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

func (*GenericError) GetStatus added in v0.40.2 

func (o *GenericError) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*GenericError) GetStatusOk added in v0.40.2 

func (o *GenericError) GetStatusOk() (*string, bool)

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

func (*GenericError) HasCode added in v0.40.2 

func (o *GenericError) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*GenericError) HasDetails added in v0.40.2 

func (o *GenericError) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (*GenericError) HasMessage added in v0.40.2 

func (o *GenericError) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*GenericError) HasReason added in v0.40.2 

func (o *GenericError) HasReason() bool

HasReason returns a boolean if a field has been set.

func (*GenericError) HasRequest added in v0.40.2 

func (o *GenericError) HasRequest() bool

HasRequest returns a boolean if a field has been set.

func (*GenericError) HasStatus added in v0.40.2 

func (o *GenericError) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (GenericError) MarshalJSON added in v0.40.2 

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

func (*GenericError) SetCode added in v0.40.2 

func (o *GenericError) SetCode(v int64)

SetCode gets a reference to the given int64 and assigns it to the Code field.

func (*GenericError) SetDetails added in v0.40.2 

func (o *GenericError) SetDetails(v []map[string]map[string]interface{})

SetDetails gets a reference to the given []map[string]map[string]interface{} and assigns it to the Details field.

func (*GenericError) SetMessage added in v0.40.2 

func (o *GenericError) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*GenericError) SetReason added in v0.40.2 

func (o *GenericError) SetReason(v string)

SetReason gets a reference to the given string and assigns it to the Reason field.

func (*GenericError) SetRequest added in v0.40.2 

func (o *GenericError) SetRequest(v string)

SetRequest gets a reference to the given string and assigns it to the Request field.

func (*GenericError) SetStatus added in v0.40.2 

func (o *GenericError) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (GenericError) ToMap added in v0.40.8 

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

func (*GenericError) UnmarshalJSON added in v0.40.4 

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

type GenericOpenAPIError 

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type HealthAPI added in v0.40.8 

type HealthAPI interface {

	/*
		IsInstanceAlive Check alive status

		This endpoint returns a 200 status code when the HTTP server is up running.
	This status does currently not include checks whether the database connection is working.

	If the service supports TLS Edge Termination, this endpoint does not require the
	`X-Forwarded-Proto` header to be set.

	Be aware that if you are running multiple nodes of this service, the health status will never
	refer to the cluster state, only to a single instance.

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

	// IsInstanceAliveExecute executes the request
	//  @return HealthStatus
	IsInstanceAliveExecute(r HealthAPIIsInstanceAliveRequest) (*HealthStatus, *http.Response, error)

	/*
		IsInstanceReady Check readiness status

		This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g.
	the database) are responsive as well.

	If the service supports TLS Edge Termination, this endpoint does not require the
	`X-Forwarded-Proto` header to be set.

	Be aware that if you are running multiple nodes of this service, the health status will never
	refer to the cluster state, only to a single instance.

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

	// IsInstanceReadyExecute executes the request
	//  @return HealthStatus
	IsInstanceReadyExecute(r HealthAPIIsInstanceReadyRequest) (*HealthStatus, *http.Response, error)
}

type HealthAPIIsInstanceAliveRequest added in v0.40.8 

type HealthAPIIsInstanceAliveRequest struct {
	ApiService HealthAPI
	// contains filtered or unexported fields
}

func (HealthAPIIsInstanceAliveRequest) Execute added in v0.40.8 

func (r HealthAPIIsInstanceAliveRequest) Execute() (*HealthStatus, *http.Response, error)

type HealthAPIIsInstanceReadyRequest added in v0.40.8 

type HealthAPIIsInstanceReadyRequest struct {
	ApiService HealthAPI
	// contains filtered or unexported fields
}

func (HealthAPIIsInstanceReadyRequest) Execute added in v0.40.8 

func (r HealthAPIIsInstanceReadyRequest) Execute() (*HealthStatus, *http.Response, error)

type HealthAPIService added in v0.40.8 

type HealthAPIService service

HealthAPIService HealthAPI service

func (*HealthAPIService) IsInstanceAlive added in v0.40.8 

func (a *HealthAPIService) IsInstanceAlive(ctx context.Context) HealthAPIIsInstanceAliveRequest

IsInstanceAlive Check alive status

This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance. 

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

func (*HealthAPIService) IsInstanceAliveExecute added in v0.40.8 

func (a *HealthAPIService) IsInstanceAliveExecute(r HealthAPIIsInstanceAliveRequest) (*HealthStatus, *http.Response, error)

Execute executes the request 

@return HealthStatus

func (*HealthAPIService) IsInstanceReady added in v0.40.8 

func (a *HealthAPIService) IsInstanceReady(ctx context.Context) HealthAPIIsInstanceReadyRequest

IsInstanceReady Check readiness status

This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g. the database) are responsive as well.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance. 

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

func (*HealthAPIService) IsInstanceReadyExecute added in v0.40.8 

func (a *HealthAPIService) IsInstanceReadyExecute(r HealthAPIIsInstanceReadyRequest) (*HealthStatus, *http.Response, error)

Execute executes the request 

@return HealthStatus

type HealthNotReadyStatus 

type HealthNotReadyStatus struct {
	// Errors contains a list of errors that caused the not ready status.
	Errors               *map[string]string `json:"errors,omitempty"`
	AdditionalProperties map[string]interface{}
}

HealthNotReadyStatus struct for HealthNotReadyStatus

func NewHealthNotReadyStatus 

func NewHealthNotReadyStatus() *HealthNotReadyStatus

NewHealthNotReadyStatus instantiates a new HealthNotReadyStatus 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 NewHealthNotReadyStatusWithDefaults 

func NewHealthNotReadyStatusWithDefaults() *HealthNotReadyStatus

NewHealthNotReadyStatusWithDefaults instantiates a new HealthNotReadyStatus 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 (*HealthNotReadyStatus) GetErrors 

func (o *HealthNotReadyStatus) GetErrors() map[string]string

GetErrors returns the Errors field value if set, zero value otherwise.

func (*HealthNotReadyStatus) GetErrorsOk 

func (o *HealthNotReadyStatus) GetErrorsOk() (*map[string]string, bool)

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

func (*HealthNotReadyStatus) HasErrors 

func (o *HealthNotReadyStatus) HasErrors() bool

HasErrors returns a boolean if a field has been set.

func (HealthNotReadyStatus) MarshalJSON 

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

func (*HealthNotReadyStatus) SetErrors 

func (o *HealthNotReadyStatus) SetErrors(v map[string]string)

SetErrors gets a reference to the given map[string]string and assigns it to the Errors field.

func (HealthNotReadyStatus) ToMap added in v0.40.8 

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

func (*HealthNotReadyStatus) UnmarshalJSON added in v0.40.4 

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

type HealthStatus 

type HealthStatus struct {
	// Status always contains \"ok\".
	Status               *string `json:"status,omitempty"`
	AdditionalProperties map[string]interface{}
}

HealthStatus struct for HealthStatus

func NewHealthStatus 

func NewHealthStatus() *HealthStatus

NewHealthStatus instantiates a new HealthStatus 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 NewHealthStatusWithDefaults 

func NewHealthStatusWithDefaults() *HealthStatus

NewHealthStatusWithDefaults instantiates a new HealthStatus 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 (*HealthStatus) GetStatus 

func (o *HealthStatus) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*HealthStatus) GetStatusOk 

func (o *HealthStatus) GetStatusOk() (*string, bool)

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

func (*HealthStatus) HasStatus 

func (o *HealthStatus) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (HealthStatus) MarshalJSON 

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

func (*HealthStatus) SetStatus 

func (o *HealthStatus) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (HealthStatus) ToMap added in v0.40.8 

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

func (*HealthStatus) UnmarshalJSON added in v0.40.4 

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

type JsonWebKey 

type JsonWebKey struct {
	// The \"alg\" (algorithm) parameter identifies the algorithm intended for use with the key.  The values used should either be registered in the IANA \"JSON Web Signature and Encryption Algorithms\" registry established by [JWA] or be a value that contains a Collision- Resistant Name.
	Alg *string `json:"alg,omitempty"`
	Crv *string `json:"crv,omitempty"`
	D   *string `json:"d,omitempty"`
	Dp  *string `json:"dp,omitempty"`
	Dq  *string `json:"dq,omitempty"`
	E   *string `json:"e,omitempty"`
	K   *string `json:"k,omitempty"`
	// The \"kid\" (key ID) parameter is used to match a specific key.  This is used, for instance, to choose among a set of keys within a JWK Set during key rollover.  The structure of the \"kid\" value is unspecified.  When \"kid\" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct \"kid\" values.  (One example in which different keys might use the same \"kid\" value is if they have different \"kty\" (key type) values but are considered to be equivalent alternatives by the application using them.)  The \"kid\" value is a case-sensitive string.
	Kid *string `json:"kid,omitempty"`
	// The \"kty\" (key type) parameter identifies the cryptographic algorithm family used with the key, such as \"RSA\" or \"EC\". \"kty\" values should either be registered in the IANA \"JSON Web Key Types\" registry established by [JWA] or be a value that contains a Collision- Resistant Name.  The \"kty\" value is a case-sensitive string.
	Kty *string `json:"kty,omitempty"`
	N   *string `json:"n,omitempty"`
	P   *string `json:"p,omitempty"`
	Q   *string `json:"q,omitempty"`
	Qi  *string `json:"qi,omitempty"`
	// The \"use\" (public key use) parameter identifies the intended use of the public key. The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).
	Use *string `json:"use,omitempty"`
	X   *string `json:"x,omitempty"`
	// The \"x5c\" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280].  The certificate chain is represented as a JSON array of certificate value strings.  Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate.
	X5c                  []string `json:"x5c,omitempty"`
	Y                    *string  `json:"y,omitempty"`
	AdditionalProperties map[string]interface{}
}

JsonWebKey struct for JsonWebKey

func NewJsonWebKey 

func NewJsonWebKey() *JsonWebKey

NewJsonWebKey instantiates a new JsonWebKey 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 NewJsonWebKeyWithDefaults 

func NewJsonWebKeyWithDefaults() *JsonWebKey

NewJsonWebKeyWithDefaults instantiates a new JsonWebKey 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 (*JsonWebKey) GetAlg 

func (o *JsonWebKey) GetAlg() string

GetAlg returns the Alg field value if set, zero value otherwise.

func (*JsonWebKey) GetAlgOk 

func (o *JsonWebKey) GetAlgOk() (*string, bool)

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

func (*JsonWebKey) GetCrv 

func (o *JsonWebKey) GetCrv() string

GetCrv returns the Crv field value if set, zero value otherwise.

func (*JsonWebKey) GetCrvOk 

func (o *JsonWebKey) GetCrvOk() (*string, bool)

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

func (*JsonWebKey) GetD 

func (o *JsonWebKey) GetD() string

GetD returns the D field value if set, zero value otherwise.

func (*JsonWebKey) GetDOk 

func (o *JsonWebKey) GetDOk() (*string, bool)

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

func (*JsonWebKey) GetDp 

func (o *JsonWebKey) GetDp() string

GetDp returns the Dp field value if set, zero value otherwise.

func (*JsonWebKey) GetDpOk 

func (o *JsonWebKey) GetDpOk() (*string, bool)

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

func (*JsonWebKey) GetDq 

func (o *JsonWebKey) GetDq() string

GetDq returns the Dq field value if set, zero value otherwise.

func (*JsonWebKey) GetDqOk 

func (o *JsonWebKey) GetDqOk() (*string, bool)

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

func (*JsonWebKey) GetE 

func (o *JsonWebKey) GetE() string

GetE returns the E field value if set, zero value otherwise.

func (*JsonWebKey) GetEOk 

func (o *JsonWebKey) GetEOk() (*string, bool)

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

func (*JsonWebKey) GetK 

func (o *JsonWebKey) GetK() string

GetK returns the K field value if set, zero value otherwise.

func (*JsonWebKey) GetKOk 

func (o *JsonWebKey) GetKOk() (*string, bool)

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

func (*JsonWebKey) GetKid 

func (o *JsonWebKey) GetKid() string

GetKid returns the Kid field value if set, zero value otherwise.

func (*JsonWebKey) GetKidOk 

func (o *JsonWebKey) GetKidOk() (*string, bool)

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

func (*JsonWebKey) GetKty 

func (o *JsonWebKey) GetKty() string

GetKty returns the Kty field value if set, zero value otherwise.

func (*JsonWebKey) GetKtyOk 

func (o *JsonWebKey) GetKtyOk() (*string, bool)

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

func (*JsonWebKey) GetN 

func (o *JsonWebKey) GetN() string

GetN returns the N field value if set, zero value otherwise.

func (*JsonWebKey) GetNOk 

func (o *JsonWebKey) GetNOk() (*string, bool)

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

func (*JsonWebKey) GetP 

func (o *JsonWebKey) GetP() string

GetP returns the P field value if set, zero value otherwise.

func (*JsonWebKey) GetPOk 

func (o *JsonWebKey) GetPOk() (*string, bool)

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

func (*JsonWebKey) GetQ 

func (o *JsonWebKey) GetQ() string

GetQ returns the Q field value if set, zero value otherwise.

func (*JsonWebKey) GetQOk 

func (o *JsonWebKey) GetQOk() (*string, bool)

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

func (*JsonWebKey) GetQi 

func (o *JsonWebKey) GetQi() string

GetQi returns the Qi field value if set, zero value otherwise.

func (*JsonWebKey) GetQiOk 

func (o *JsonWebKey) GetQiOk() (*string, bool)

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

func (*JsonWebKey) GetUse 

func (o *JsonWebKey) GetUse() string

GetUse returns the Use field value if set, zero value otherwise.

func (*JsonWebKey) GetUseOk 

func (o *JsonWebKey) GetUseOk() (*string, bool)

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

func (*JsonWebKey) GetX 

func (o *JsonWebKey) GetX() string

GetX returns the X field value if set, zero value otherwise.

func (*JsonWebKey) GetX5c 

func (o *JsonWebKey) GetX5c() []string

GetX5c returns the X5c field value if set, zero value otherwise.

func (*JsonWebKey) GetX5cOk 

func (o *JsonWebKey) GetX5cOk() ([]string, bool)

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

func (*JsonWebKey) GetXOk 

func (o *JsonWebKey) GetXOk() (*string, bool)

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

func (*JsonWebKey) GetY 

func (o *JsonWebKey) GetY() string

GetY returns the Y field value if set, zero value otherwise.

func (*JsonWebKey) GetYOk 

func (o *JsonWebKey) GetYOk() (*string, bool)

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

func (*JsonWebKey) HasAlg 

func (o *JsonWebKey) HasAlg() bool

HasAlg returns a boolean if a field has been set.

func (*JsonWebKey) HasCrv 

func (o *JsonWebKey) HasCrv() bool

HasCrv returns a boolean if a field has been set.

func (*JsonWebKey) HasD 

func (o *JsonWebKey) HasD() bool

HasD returns a boolean if a field has been set.

func (*JsonWebKey) HasDp 

func (o *JsonWebKey) HasDp() bool

HasDp returns a boolean if a field has been set.

func (*JsonWebKey) HasDq 

func (o *JsonWebKey) HasDq() bool

HasDq returns a boolean if a field has been set.

func (*JsonWebKey) HasE 

func (o *JsonWebKey) HasE() bool

HasE returns a boolean if a field has been set.

func (*JsonWebKey) HasK 

func (o *JsonWebKey) HasK() bool

HasK returns a boolean if a field has been set.

func (*JsonWebKey) HasKid 

func (o *JsonWebKey) HasKid() bool

HasKid returns a boolean if a field has been set.

func (*JsonWebKey) HasKty 

func (o *JsonWebKey) HasKty() bool

HasKty returns a boolean if a field has been set.

func (*JsonWebKey) HasN 

func (o *JsonWebKey) HasN() bool

HasN returns a boolean if a field has been set.

func (*JsonWebKey) HasP 

func (o *JsonWebKey) HasP() bool

HasP returns a boolean if a field has been set.

func (*JsonWebKey) HasQ 

func (o *JsonWebKey) HasQ() bool

HasQ returns a boolean if a field has been set.

func (*JsonWebKey) HasQi 

func (o *JsonWebKey) HasQi() bool

HasQi returns a boolean if a field has been set.

func (*JsonWebKey) HasUse 

func (o *JsonWebKey) HasUse() bool

HasUse returns a boolean if a field has been set.

func (*JsonWebKey) HasX 

func (o *JsonWebKey) HasX() bool

HasX returns a boolean if a field has been set.

func (*JsonWebKey) HasX5c 

func (o *JsonWebKey) HasX5c() bool

HasX5c returns a boolean if a field has been set.

func (*JsonWebKey) HasY 

func (o *JsonWebKey) HasY() bool

HasY returns a boolean if a field has been set.

func (JsonWebKey) MarshalJSON 

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

func (*JsonWebKey) SetAlg 

func (o *JsonWebKey) SetAlg(v string)

SetAlg gets a reference to the given string and assigns it to the Alg field.

func (*JsonWebKey) SetCrv 

func (o *JsonWebKey) SetCrv(v string)

SetCrv gets a reference to the given string and assigns it to the Crv field.

func (*JsonWebKey) SetD 

func (o *JsonWebKey) SetD(v string)

SetD gets a reference to the given string and assigns it to the D field.

func (*JsonWebKey) SetDp 

func (o *JsonWebKey) SetDp(v string)

SetDp gets a reference to the given string and assigns it to the Dp field.

func (*JsonWebKey) SetDq 

func (o *JsonWebKey) SetDq(v string)

SetDq gets a reference to the given string and assigns it to the Dq field.

func (*JsonWebKey) SetE 

func (o *JsonWebKey) SetE(v string)

SetE gets a reference to the given string and assigns it to the E field.

func (*JsonWebKey) SetK 

func (o *JsonWebKey) SetK(v string)

SetK gets a reference to the given string and assigns it to the K field.

func (*JsonWebKey) SetKid 

func (o *JsonWebKey) SetKid(v string)

SetKid gets a reference to the given string and assigns it to the Kid field.

func (*JsonWebKey) SetKty 

func (o *JsonWebKey) SetKty(v string)

SetKty gets a reference to the given string and assigns it to the Kty field.

func (*JsonWebKey) SetN 

func (o *JsonWebKey) SetN(v string)

SetN gets a reference to the given string and assigns it to the N field.

func (*JsonWebKey) SetP 

func (o *JsonWebKey) SetP(v string)

SetP gets a reference to the given string and assigns it to the P field.

func (*JsonWebKey) SetQ 

func (o *JsonWebKey) SetQ(v string)

SetQ gets a reference to the given string and assigns it to the Q field.

func (*JsonWebKey) SetQi 

func (o *JsonWebKey) SetQi(v string)

SetQi gets a reference to the given string and assigns it to the Qi field.

func (*JsonWebKey) SetUse 

func (o *JsonWebKey) SetUse(v string)

SetUse gets a reference to the given string and assigns it to the Use field.

func (*JsonWebKey) SetX 

func (o *JsonWebKey) SetX(v string)

SetX gets a reference to the given string and assigns it to the X field.

func (*JsonWebKey) SetX5c 

func (o *JsonWebKey) SetX5c(v []string)

SetX5c gets a reference to the given []string and assigns it to the X5c field.

func (*JsonWebKey) SetY 

func (o *JsonWebKey) SetY(v string)

SetY gets a reference to the given string and assigns it to the Y field.

func (JsonWebKey) ToMap added in v0.40.8 

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

func (*JsonWebKey) UnmarshalJSON added in v0.40.4 

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

type JsonWebKeySet 

type JsonWebKeySet struct {
	// The value of the \"keys\" parameter is an array of JWK values.  By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired.
	Keys                 []JsonWebKey `json:"keys,omitempty"`
	AdditionalProperties map[string]interface{}
}

JsonWebKeySet struct for JsonWebKeySet

func NewJsonWebKeySet 

func NewJsonWebKeySet() *JsonWebKeySet

NewJsonWebKeySet instantiates a new JsonWebKeySet 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 NewJsonWebKeySetWithDefaults 

func NewJsonWebKeySetWithDefaults() *JsonWebKeySet

NewJsonWebKeySetWithDefaults instantiates a new JsonWebKeySet 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 (*JsonWebKeySet) GetKeys 

func (o *JsonWebKeySet) GetKeys() []JsonWebKey

GetKeys returns the Keys field value if set, zero value otherwise.

func (*JsonWebKeySet) GetKeysOk 

func (o *JsonWebKeySet) GetKeysOk() ([]JsonWebKey, bool)

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

func (*JsonWebKeySet) HasKeys 

func (o *JsonWebKeySet) HasKeys() bool

HasKeys returns a boolean if a field has been set.

func (JsonWebKeySet) MarshalJSON 

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

func (*JsonWebKeySet) SetKeys 

func (o *JsonWebKeySet) SetKeys(v []JsonWebKey)

SetKeys gets a reference to the given []JsonWebKey and assigns it to the Keys field.

func (JsonWebKeySet) ToMap added in v0.40.8 

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

func (*JsonWebKeySet) UnmarshalJSON added in v0.40.4 

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

type MappedNullable added in v0.40.8 

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 NullableGenericError added in v0.40.2 

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

func NewNullableGenericError added in v0.40.2 

func NewNullableGenericError(val *GenericError) *NullableGenericError

func (NullableGenericError) Get added in v0.40.2 

func (v NullableGenericError) Get() *GenericError

func (NullableGenericError) IsSet added in v0.40.2 

func (v NullableGenericError) IsSet() bool

func (NullableGenericError) MarshalJSON added in v0.40.2 

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

func (*NullableGenericError) Set added in v0.40.2 

func (v *NullableGenericError) Set(val *GenericError)

func (*NullableGenericError) UnmarshalJSON added in v0.40.2 

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

func (*NullableGenericError) Unset added in v0.40.2 

func (v *NullableGenericError) Unset()

type NullableHealthNotReadyStatus 

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

func NewNullableHealthNotReadyStatus 

func NewNullableHealthNotReadyStatus(val *HealthNotReadyStatus) *NullableHealthNotReadyStatus

func (NullableHealthNotReadyStatus) Get 

func (v NullableHealthNotReadyStatus) Get() *HealthNotReadyStatus

func (NullableHealthNotReadyStatus) IsSet 

func (v NullableHealthNotReadyStatus) IsSet() bool

func (NullableHealthNotReadyStatus) MarshalJSON 

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

func (*NullableHealthNotReadyStatus) Set 

func (v *NullableHealthNotReadyStatus) Set(val *HealthNotReadyStatus)

func (*NullableHealthNotReadyStatus) UnmarshalJSON 

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

func (*NullableHealthNotReadyStatus) Unset 

func (v *NullableHealthNotReadyStatus) Unset()

type NullableHealthStatus 

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

func NewNullableHealthStatus 

func NewNullableHealthStatus(val *HealthStatus) *NullableHealthStatus

func (NullableHealthStatus) Get 

func (v NullableHealthStatus) Get() *HealthStatus

func (NullableHealthStatus) IsSet 

func (v NullableHealthStatus) IsSet() bool

func (NullableHealthStatus) MarshalJSON 

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

func (*NullableHealthStatus) Set 

func (v *NullableHealthStatus) Set(val *HealthStatus)

func (*NullableHealthStatus) UnmarshalJSON 

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

func (*NullableHealthStatus) Unset 

func (v *NullableHealthStatus) 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 NullableJsonWebKey 

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

func NewNullableJsonWebKey 

func NewNullableJsonWebKey(val *JsonWebKey) *NullableJsonWebKey

func (NullableJsonWebKey) Get 

func (v NullableJsonWebKey) Get() *JsonWebKey

func (NullableJsonWebKey) IsSet 

func (v NullableJsonWebKey) IsSet() bool

func (NullableJsonWebKey) MarshalJSON 

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

func (*NullableJsonWebKey) Set 

func (v *NullableJsonWebKey) Set(val *JsonWebKey)

func (*NullableJsonWebKey) UnmarshalJSON 

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

func (*NullableJsonWebKey) Unset 

func (v *NullableJsonWebKey) Unset()

type NullableJsonWebKeySet 

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

func NewNullableJsonWebKeySet 

func NewNullableJsonWebKeySet(val *JsonWebKeySet) *NullableJsonWebKeySet

func (NullableJsonWebKeySet) Get 

func (v NullableJsonWebKeySet) Get() *JsonWebKeySet

func (NullableJsonWebKeySet) IsSet 

func (v NullableJsonWebKeySet) IsSet() bool

func (NullableJsonWebKeySet) MarshalJSON 

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

func (*NullableJsonWebKeySet) Set 

func (v *NullableJsonWebKeySet) Set(val *JsonWebKeySet)

func (*NullableJsonWebKeySet) UnmarshalJSON 

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

func (*NullableJsonWebKeySet) Unset 

func (v *NullableJsonWebKeySet) Unset()

type NullableRule 

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

func NewNullableRule 

func NewNullableRule(val *Rule) *NullableRule

func (NullableRule) Get 

func (v NullableRule) Get() *Rule

func (NullableRule) IsSet 

func (v NullableRule) IsSet() bool

func (NullableRule) MarshalJSON 

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

func (*NullableRule) Set 

func (v *NullableRule) Set(val *Rule)

func (*NullableRule) UnmarshalJSON 

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

func (*NullableRule) Unset 

func (v *NullableRule) Unset()

type NullableRuleHandler 

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

func NewNullableRuleHandler 

func NewNullableRuleHandler(val *RuleHandler) *NullableRuleHandler

func (NullableRuleHandler) Get 

func (v NullableRuleHandler) Get() *RuleHandler

func (NullableRuleHandler) IsSet 

func (v NullableRuleHandler) IsSet() bool

func (NullableRuleHandler) MarshalJSON 

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

func (*NullableRuleHandler) Set 

func (v *NullableRuleHandler) Set(val *RuleHandler)

func (*NullableRuleHandler) UnmarshalJSON 

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

func (*NullableRuleHandler) Unset 

func (v *NullableRuleHandler) Unset()

type NullableRuleMatch 

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

func NewNullableRuleMatch 

func NewNullableRuleMatch(val *RuleMatch) *NullableRuleMatch

func (NullableRuleMatch) Get 

func (v NullableRuleMatch) Get() *RuleMatch

func (NullableRuleMatch) IsSet 

func (v NullableRuleMatch) IsSet() bool

func (NullableRuleMatch) MarshalJSON 

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

func (*NullableRuleMatch) Set 

func (v *NullableRuleMatch) Set(val *RuleMatch)

func (*NullableRuleMatch) UnmarshalJSON 

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

func (*NullableRuleMatch) Unset 

func (v *NullableRuleMatch) 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 NullableUpstream 

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

func NewNullableUpstream 

func NewNullableUpstream(val *Upstream) *NullableUpstream

func (NullableUpstream) Get 

func (v NullableUpstream) Get() *Upstream

func (NullableUpstream) IsSet 

func (v NullableUpstream) IsSet() bool

func (NullableUpstream) MarshalJSON 

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

func (*NullableUpstream) Set 

func (v *NullableUpstream) Set(val *Upstream)

func (*NullableUpstream) UnmarshalJSON 

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

func (*NullableUpstream) Unset 

func (v *NullableUpstream) Unset()

type NullableVersion 

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

func NewNullableVersion 

func NewNullableVersion(val *Version) *NullableVersion

func (NullableVersion) Get 

func (v NullableVersion) Get() *Version

func (NullableVersion) IsSet 

func (v NullableVersion) IsSet() bool

func (NullableVersion) MarshalJSON 

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

func (*NullableVersion) Set 

func (v *NullableVersion) Set(val *Version)

func (*NullableVersion) UnmarshalJSON 

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

func (*NullableVersion) Unset 

func (v *NullableVersion) Unset()

type Rule 

type Rule struct {
	// Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used.  If you want the rule to first check a specific authenticator  before \"falling back\" to others, have that authenticator as the first item in the array.
	Authenticators []RuleHandler `json:"authenticators,omitempty"`
	Authorizer     *RuleHandler  `json:"authorizer,omitempty"`
	// Description is a human readable description of this rule.
	Description *string `json:"description,omitempty"`
	// ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule.
	Id    *string    `json:"id,omitempty"`
	Match *RuleMatch `json:"match,omitempty"`
	// Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server.  Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded.
	Mutators             []RuleHandler `json:"mutators,omitempty"`
	Upstream             *Upstream     `json:"upstream,omitempty"`
	AdditionalProperties map[string]interface{}
}

Rule struct for Rule

func NewRule 

func NewRule() *Rule

NewRule instantiates a new Rule 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 NewRuleWithDefaults 

func NewRuleWithDefaults() *Rule

NewRuleWithDefaults instantiates a new Rule 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 (*Rule) GetAuthenticators 

func (o *Rule) GetAuthenticators() []RuleHandler

GetAuthenticators returns the Authenticators field value if set, zero value otherwise.

func (*Rule) GetAuthenticatorsOk 

func (o *Rule) GetAuthenticatorsOk() ([]RuleHandler, bool)

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

func (*Rule) GetAuthorizer 

func (o *Rule) GetAuthorizer() RuleHandler

GetAuthorizer returns the Authorizer field value if set, zero value otherwise.

func (*Rule) GetAuthorizerOk 

func (o *Rule) GetAuthorizerOk() (*RuleHandler, bool)

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

func (*Rule) GetDescription 

func (o *Rule) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*Rule) GetDescriptionOk 

func (o *Rule) GetDescriptionOk() (*string, bool)

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

func (*Rule) GetId 

func (o *Rule) GetId() string

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

func (*Rule) GetIdOk 

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

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

func (*Rule) GetMatch 

func (o *Rule) GetMatch() RuleMatch

GetMatch returns the Match field value if set, zero value otherwise.

func (*Rule) GetMatchOk 

func (o *Rule) GetMatchOk() (*RuleMatch, bool)

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

func (*Rule) GetMutators 

func (o *Rule) GetMutators() []RuleHandler

GetMutators returns the Mutators field value if set, zero value otherwise.

func (*Rule) GetMutatorsOk 

func (o *Rule) GetMutatorsOk() ([]RuleHandler, bool)

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

func (*Rule) GetUpstream 

func (o *Rule) GetUpstream() Upstream

GetUpstream returns the Upstream field value if set, zero value otherwise.

func (*Rule) GetUpstreamOk 

func (o *Rule) GetUpstreamOk() (*Upstream, bool)

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

func (*Rule) HasAuthenticators 

func (o *Rule) HasAuthenticators() bool

HasAuthenticators returns a boolean if a field has been set.

func (*Rule) HasAuthorizer 

func (o *Rule) HasAuthorizer() bool

HasAuthorizer returns a boolean if a field has been set.

func (*Rule) HasDescription 

func (o *Rule) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Rule) HasId 

func (o *Rule) HasId() bool

HasId returns a boolean if a field has been set.

func (*Rule) HasMatch 

func (o *Rule) HasMatch() bool

HasMatch returns a boolean if a field has been set.

func (*Rule) HasMutators 

func (o *Rule) HasMutators() bool

HasMutators returns a boolean if a field has been set.

func (*Rule) HasUpstream 

func (o *Rule) HasUpstream() bool

HasUpstream returns a boolean if a field has been set.

func (Rule) MarshalJSON 

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

func (*Rule) SetAuthenticators 

func (o *Rule) SetAuthenticators(v []RuleHandler)

SetAuthenticators gets a reference to the given []RuleHandler and assigns it to the Authenticators field.

func (*Rule) SetAuthorizer 

func (o *Rule) SetAuthorizer(v RuleHandler)

SetAuthorizer gets a reference to the given RuleHandler and assigns it to the Authorizer field.

func (*Rule) SetDescription 

func (o *Rule) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*Rule) SetId 

func (o *Rule) SetId(v string)

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

func (*Rule) SetMatch 

func (o *Rule) SetMatch(v RuleMatch)

SetMatch gets a reference to the given RuleMatch and assigns it to the Match field.

func (*Rule) SetMutators 

func (o *Rule) SetMutators(v []RuleHandler)

SetMutators gets a reference to the given []RuleHandler and assigns it to the Mutators field.

func (*Rule) SetUpstream 

func (o *Rule) SetUpstream(v Upstream)

SetUpstream gets a reference to the given Upstream and assigns it to the Upstream field.

func (Rule) ToMap added in v0.40.8 

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

func (*Rule) UnmarshalJSON added in v0.40.4 

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

type RuleHandler 

type RuleHandler struct {
	// Config contains the configuration for the handler. Please read the user guide for a complete list of each handler's available settings.
	Config map[string]interface{} `json:"config,omitempty"`
	// Handler identifies the implementation which will be used to handle this specific request. Please read the user guide for a complete list of available handlers.
	Handler              *string `json:"handler,omitempty"`
	AdditionalProperties map[string]interface{}
}

RuleHandler struct for RuleHandler

func NewRuleHandler 

func NewRuleHandler() *RuleHandler

NewRuleHandler instantiates a new RuleHandler 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 NewRuleHandlerWithDefaults 

func NewRuleHandlerWithDefaults() *RuleHandler

NewRuleHandlerWithDefaults instantiates a new RuleHandler 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 (*RuleHandler) GetConfig 

func (o *RuleHandler) GetConfig() map[string]interface{}

GetConfig returns the Config field value if set, zero value otherwise.

func (*RuleHandler) GetConfigOk 

func (o *RuleHandler) GetConfigOk() (map[string]interface{}, bool)

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

func (*RuleHandler) GetHandler 

func (o *RuleHandler) GetHandler() string

GetHandler returns the Handler field value if set, zero value otherwise.

func (*RuleHandler) GetHandlerOk 

func (o *RuleHandler) GetHandlerOk() (*string, bool)

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

func (*RuleHandler) HasConfig 

func (o *RuleHandler) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*RuleHandler) HasHandler 

func (o *RuleHandler) HasHandler() bool

HasHandler returns a boolean if a field has been set.

func (RuleHandler) MarshalJSON 

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

func (*RuleHandler) SetConfig 

func (o *RuleHandler) SetConfig(v map[string]interface{})

SetConfig gets a reference to the given map[string]interface{} and assigns it to the Config field.

func (*RuleHandler) SetHandler 

func (o *RuleHandler) SetHandler(v string)

SetHandler gets a reference to the given string and assigns it to the Handler field.

func (RuleHandler) ToMap added in v0.40.8 

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

func (*RuleHandler) UnmarshalJSON added in v0.40.4 

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

type RuleMatch 

type RuleMatch struct {
	// An array of HTTP methods (e.g. GET, POST, PUT, DELETE, ...). When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the HTTP method of the incoming request with the HTTP methods of each rules. If a match is found, the rule is considered a partial match. If the matchesUrl field is satisfied as well, the rule is considered a full match.
	Methods []string `json:"methods,omitempty"`
	// This field represents the URL pattern this rule matches. When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the full request URL (e.g. https://mydomain.com/api/resource) without query parameters of the incoming request with this field. If a match is found, the rule is considered a partial match. If the matchesMethods field is satisfied as well, the rule is considered a full match.  You can use regular expressions in this field to match more than one url. Regular expressions are encapsulated in brackets < and >. The following example matches all paths of the domain `mydomain.com`: `https://mydomain.com/<.*>`.
	Url                  *string `json:"url,omitempty"`
	AdditionalProperties map[string]interface{}
}

RuleMatch struct for RuleMatch

func NewRuleMatch 

func NewRuleMatch() *RuleMatch

NewRuleMatch instantiates a new RuleMatch 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 NewRuleMatchWithDefaults 

func NewRuleMatchWithDefaults() *RuleMatch

NewRuleMatchWithDefaults instantiates a new RuleMatch 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 (*RuleMatch) GetMethods 

func (o *RuleMatch) GetMethods() []string

GetMethods returns the Methods field value if set, zero value otherwise.

func (*RuleMatch) GetMethodsOk 

func (o *RuleMatch) GetMethodsOk() ([]string, bool)

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

func (*RuleMatch) GetUrl 

func (o *RuleMatch) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*RuleMatch) GetUrlOk 

func (o *RuleMatch) GetUrlOk() (*string, bool)

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

func (*RuleMatch) HasMethods 

func (o *RuleMatch) HasMethods() bool

HasMethods returns a boolean if a field has been set.

func (*RuleMatch) HasUrl 

func (o *RuleMatch) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (RuleMatch) MarshalJSON 

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

func (*RuleMatch) SetMethods 

func (o *RuleMatch) SetMethods(v []string)

SetMethods gets a reference to the given []string and assigns it to the Methods field.

func (*RuleMatch) SetUrl 

func (o *RuleMatch) SetUrl(v string)

SetUrl gets a reference to the given string and assigns it to the Url field.

func (RuleMatch) ToMap added in v0.40.8 

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

func (*RuleMatch) UnmarshalJSON added in v0.40.4 

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

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Upstream 

type Upstream struct {
	// PreserveHost, if false (the default), tells ORY Oathkeeper to set the upstream request's Host header to the hostname of the API's upstream's URL. Setting this flag to true instructs ORY Oathkeeper not to do so.
	PreserveHost *bool `json:"preserve_host,omitempty"`
	// StripPath if set, replaces the provided path prefix when forwarding the requested URL to the upstream URL.
	StripPath *string `json:"strip_path,omitempty"`
	// URL is the URL the request will be proxied to.
	Url                  *string `json:"url,omitempty"`
	AdditionalProperties map[string]interface{}
}

Upstream struct for Upstream

func NewUpstream 

func NewUpstream() *Upstream

NewUpstream instantiates a new Upstream 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 NewUpstreamWithDefaults 

func NewUpstreamWithDefaults() *Upstream

NewUpstreamWithDefaults instantiates a new Upstream 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 (*Upstream) GetPreserveHost 

func (o *Upstream) GetPreserveHost() bool

GetPreserveHost returns the PreserveHost field value if set, zero value otherwise.

func (*Upstream) GetPreserveHostOk 

func (o *Upstream) GetPreserveHostOk() (*bool, bool)

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

func (*Upstream) GetStripPath 

func (o *Upstream) GetStripPath() string

GetStripPath returns the StripPath field value if set, zero value otherwise.

func (*Upstream) GetStripPathOk 

func (o *Upstream) GetStripPathOk() (*string, bool)

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

func (*Upstream) GetUrl 

func (o *Upstream) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*Upstream) GetUrlOk 

func (o *Upstream) GetUrlOk() (*string, bool)

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

func (*Upstream) HasPreserveHost 

func (o *Upstream) HasPreserveHost() bool

HasPreserveHost returns a boolean if a field has been set.

func (*Upstream) HasStripPath 

func (o *Upstream) HasStripPath() bool

HasStripPath returns a boolean if a field has been set.

func (*Upstream) HasUrl 

func (o *Upstream) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (Upstream) MarshalJSON 

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

func (*Upstream) SetPreserveHost 

func (o *Upstream) SetPreserveHost(v bool)

SetPreserveHost gets a reference to the given bool and assigns it to the PreserveHost field.

func (*Upstream) SetStripPath 

func (o *Upstream) SetStripPath(v string)

SetStripPath gets a reference to the given string and assigns it to the StripPath field.

func (*Upstream) SetUrl 

func (o *Upstream) SetUrl(v string)

SetUrl gets a reference to the given string and assigns it to the Url field.

func (Upstream) ToMap added in v0.40.8 

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

func (*Upstream) UnmarshalJSON added in v0.40.4 

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

type Version 

type Version struct {
	// Version is the service's version.
	Version              *string `json:"version,omitempty"`
	AdditionalProperties map[string]interface{}
}

Version struct for Version

func NewVersion 

func NewVersion() *Version

NewVersion instantiates a new Version 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 NewVersionWithDefaults 

func NewVersionWithDefaults() *Version

NewVersionWithDefaults instantiates a new Version 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 (*Version) GetVersion 

func (o *Version) GetVersion() string

GetVersion returns the Version field value if set, zero value otherwise.

func (*Version) GetVersionOk 

func (o *Version) GetVersionOk() (*string, bool)

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

func (*Version) HasVersion 

func (o *Version) HasVersion() bool

HasVersion returns a boolean if a field has been set.

func (Version) MarshalJSON 

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

func (*Version) SetVersion 

func (o *Version) SetVersion(v string)

SetVersion gets a reference to the given string and assigns it to the Version field.

func (Version) ToMap added in v0.40.8 

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

func (*Version) UnmarshalJSON added in v0.40.4 

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

type VersionAPI added in v0.40.8 

type VersionAPI interface {

	/*
		GetVersion Get service version

		This endpoint returns the service version typically notated using semantic versioning.

	If the service supports TLS Edge Termination, this endpoint does not require the
	`X-Forwarded-Proto` header to be set.

	Be aware that if you are running multiple nodes of this service, the health status will never
	refer to the cluster state, only to a single instance.

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

	// GetVersionExecute executes the request
	//  @return Version
	GetVersionExecute(r VersionAPIGetVersionRequest) (*Version, *http.Response, error)
}

type VersionAPIGetVersionRequest added in v0.40.8 

type VersionAPIGetVersionRequest struct {
	ApiService VersionAPI
	// contains filtered or unexported fields
}

func (VersionAPIGetVersionRequest) Execute added in v0.40.8 

func (r VersionAPIGetVersionRequest) Execute() (*Version, *http.Response, error)

type VersionAPIService added in v0.40.8 

type VersionAPIService service

VersionAPIService VersionAPI service

func (*VersionAPIService) GetVersion added in v0.40.8 

func (a *VersionAPIService) GetVersion(ctx context.Context) VersionAPIGetVersionRequest

GetVersion Get service version

This endpoint returns the service version typically notated using semantic versioning.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance. 

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

func (*VersionAPIService) GetVersionExecute added in v0.40.8 

func (a *VersionAPIService) GetVersionExecute(r VersionAPIGetVersionRequest) (*Version, *http.Response, error)

Execute executes the request 

@return Version

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.